837bc98a1d
## Overview Adds LM Studio OSS support. Closes #1883 ### Changes This PR enhances the behavior of `--oss` flag to support LM Studio as a provider. Additionally, it introduces a new flag`--local-provider` which can take in `lmstudio` or `ollama` as values if the user wants to explicitly choose which one to use. If no provider is specified `codex --oss` will auto-select the provider based on whichever is running. #### Additional enhancements The default can be set using `oss-provider` in config like: ``` oss_provider = "lmstudio" ``` For non-interactive users, they will need to either provide the provider as an arg or have it in their `config.toml` ### Notes For best performance, [set the default context length](https://lmstudio.ai/docs/app/advanced/per-model) for gpt-oss to the maximum your machine can support --------- Co-authored-by: Matt Clayton <matt@lmstudio.ai> Co-authored-by: Eric Traut <etraut@openai.com>
86 lines
3.3 KiB
Rust
86 lines
3.3 KiB
Rust
use clap::Parser;
|
||
use clap::ValueHint;
|
||
use codex_common::ApprovalModeCliArg;
|
||
use codex_common::CliConfigOverrides;
|
||
use std::path::PathBuf;
|
||
|
||
#[derive(Parser, Debug)]
|
||
#[command(version)]
|
||
pub struct Cli {
|
||
/// Optional user prompt to start the session.
|
||
#[arg(value_name = "PROMPT", value_hint = clap::ValueHint::Other)]
|
||
pub prompt: Option<String>,
|
||
|
||
/// Optional image(s) to attach to the initial prompt.
|
||
#[arg(long = "image", short = 'i', value_name = "FILE", value_delimiter = ',', num_args = 1..)]
|
||
pub images: Vec<PathBuf>,
|
||
|
||
// Internal controls set by the top-level `codex resume` subcommand.
|
||
// These are not exposed as user flags on the base `codex` command.
|
||
#[clap(skip)]
|
||
pub resume_picker: bool,
|
||
|
||
#[clap(skip)]
|
||
pub resume_last: bool,
|
||
|
||
/// Internal: resume a specific recorded session by id (UUID). Set by the
|
||
/// top-level `codex resume <SESSION_ID>` wrapper; not exposed as a public flag.
|
||
#[clap(skip)]
|
||
pub resume_session_id: Option<String>,
|
||
|
||
/// Model the agent should use.
|
||
#[arg(long, short = 'm')]
|
||
pub model: Option<String>,
|
||
|
||
/// Convenience flag to select the local open source model provider. Equivalent to -c
|
||
/// model_provider=oss; verifies a local LM Studio or Ollama server is running.
|
||
#[arg(long = "oss", default_value_t = false)]
|
||
pub oss: bool,
|
||
|
||
/// Specify which local provider to use (lmstudio or ollama).
|
||
/// If not specified with --oss, will use config default or show selection.
|
||
#[arg(long = "local-provider")]
|
||
pub oss_provider: Option<String>,
|
||
|
||
/// Configuration profile from config.toml to specify default options.
|
||
#[arg(long = "profile", short = 'p')]
|
||
pub config_profile: Option<String>,
|
||
|
||
/// Select the sandbox policy to use when executing model-generated shell
|
||
/// commands.
|
||
#[arg(long = "sandbox", short = 's')]
|
||
pub sandbox_mode: Option<codex_common::SandboxModeCliArg>,
|
||
|
||
/// Configure when the model requires human approval before executing a command.
|
||
#[arg(long = "ask-for-approval", short = 'a')]
|
||
pub approval_policy: Option<ApprovalModeCliArg>,
|
||
|
||
/// Convenience alias for low-friction sandboxed automatic execution (-a on-request, --sandbox workspace-write).
|
||
#[arg(long = "full-auto", default_value_t = false)]
|
||
pub full_auto: bool,
|
||
|
||
/// Skip all confirmation prompts and execute commands without sandboxing.
|
||
/// EXTREMELY DANGEROUS. Intended solely for running in environments that are externally sandboxed.
|
||
#[arg(
|
||
long = "dangerously-bypass-approvals-and-sandbox",
|
||
alias = "yolo",
|
||
default_value_t = false,
|
||
conflicts_with_all = ["approval_policy", "full_auto"]
|
||
)]
|
||
pub dangerously_bypass_approvals_and_sandbox: bool,
|
||
|
||
/// Tell the agent to use the specified directory as its working root.
|
||
#[clap(long = "cd", short = 'C', value_name = "DIR")]
|
||
pub cwd: Option<PathBuf>,
|
||
|
||
/// Enable web search (off by default). When enabled, the native Responses `web_search` tool is available to the model (no per‑call approval).
|
||
#[arg(long = "search", default_value_t = false)]
|
||
pub web_search: bool,
|
||
|
||
/// Additional directories that should be writable alongside the primary workspace.
|
||
#[arg(long = "add-dir", value_name = "DIR", value_hint = ValueHint::DirPath)]
|
||
pub add_dir: Vec<PathBuf>,
|
||
|
||
#[clap(skip)]
|
||
pub config_overrides: CliConfigOverrides,
|
||
}
|