Struct PiCliBuilder 

pub struct PiCliBuilder { /* private fields */ }

Typed argv builder for the pi CLI.

use pi_codes::cli::{Mode, PiCliBuilder};
let args = PiCliBuilder::new()
    .mode(Mode::Rpc)
    .no_session(true)
    .assembled_args();
assert_eq!(args[0], "--mode");

Implementations

impl PiCliBuilder

pub fn new() -> Self

pub fn mode(self, mode: Mode) -> Self

pub fn provider(self, provider: impl Into<String>) -> Self

Restrict --model lookup to one provider. pi 1.0.0+ rejects --provider without --model (Error: --provider requires --model, exit 1), so pair this with model.

pub fn model(self, model: impl Into<String>) -> Self

pub fn api_key(self, key: impl Into<String>) -> Self

API key for the provider. Prefer environment variables — argv is visible to other processes; this exists for parity with the CLI.

pub fn system_prompt(self, prompt: impl Into<String>) -> Self

pub fn session(self, session: impl Into<String>) -> Self

--session <path|id> — use a specific session file or partial id.

pub fn session_dir(self, dir: impl Into<PathBuf>) -> Self

pub fn session_id(self, id: impl Into<String>) -> Self

--session-id <id> — exact project session id, created if missing.

pub fn fork(self, source: impl Into<String>) -> Self

--fork <path|id> — fork a session into a new one.

pub fn continue_session(self, enabled: bool) -> Self

--continue — continue the previous session.

pub fn no_session(self, enabled: bool) -> Self

--no-session — ephemeral run, nothing persisted.

pub fn name(self, name: impl Into<String>) -> Self

--name — session display name.

pub fn no_tools(self, enabled: bool) -> Self

--no-tools — disable all tools.

pub fn tools(self, tools: impl Into<String>) -> Self

--tools — comma-separated tool allowlist. Entries are tool names or patterns where * matches any characters (pi 1.0.4+). MCP tools are kept unless an entry starts with mcp__. Entries written as +name / -name add to or remove from the default selection instead of replacing it (pi 1.1.0+), e.g. "+codemode,-write".

pub fn exclude_tools(self, tools: impl Into<String>) -> Self

--exclude-tools — comma-separated tool denylist of names or * patterns, MCP tools included (pi 1.0.4+).

pub fn thinking(self, level: impl Into<String>) -> Self

--thinking — off, minimal, low, medium, high, xhigh, max.

pub fn print(self, enabled: bool) -> Self

--print — non-interactive: process the prompt and exit.

pub fn approve(self, enabled: bool) -> Self

--approve — trust project-local files (extensions, AGENTS.md) for this run. Note pi has NO tool-approval gate: read/bash/edit/ write always run without prompting; this flag is only about trusting local config.

pub fn no_approve(self, enabled: bool) -> Self

--no-approve — ignore project-local files for this run.

pub fn offline(self, enabled: bool) -> Self

--offline — disable startup network operations.

pub fn no_mcp(self, enabled: bool) -> Self

--no-mcp — disable the built-in MCP support for this run: no servers connect and there are no MCP tools (pi 1.0.4+).

pub fn working_directory(self, dir: impl Into<PathBuf>) -> Self

Working directory for the spawned process (not a pi flag — pi’s tools operate relative to its cwd). Used by crate::client_async::PiRpcClient::spawn.

pub fn get_working_directory(&self) -> Option<&Path>

The configured working directory, if any.

pub fn extra_args<I, S>(self, args: I) -> Self

where I: IntoIterator<Item = S>, S: Into<OsString>,

Escape hatch: raw args appended after every typed flag, before the positional prompt.

pub fn prompt(self, prompt: impl Into<String>) -> Self

Positional prompt (used with --mode json one-shots).

pub fn assembled_args(&self) -> Vec<OsString>

The full argv (binary not included) — pure and testable.

Trait Implementations

impl Clone for PiCliBuilder

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PiCliBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PiCliBuilder

fn default() -> Self

Returns the “default value” for a type.