froe

Froe CLI command reference

Froe CLI is the terminal adapter over Froe core. This page covers terminal commands and options; agent runs, actions, and safety policy belong to the core.

Command syntax froe [options] [task...]

Start a Run with a task.

A task supplied on the command line starts one bounded Run in the current Workspace unless you set another path.

  1. froe "Fix the failing parser tests"

    Run one coding task

    The CLI submits the quoted task to Froe core as one outcome to investigate, change, and verify.

  2. froe

    Continue in an interactive terminal

    Send follow-up tasks in the same in-process conversation. Each non-empty message begins its own bounded run.

  3. froe mcp add context7 -- npx -y @upstash/context7-mcp

    Add an MCP server

    Save a stdio server or remote endpoint that can provide tools and context to the model.

  4. froe --help

    Print the reference

    Show the option list and the command syntax supported by the package.

  5. froe --version

    Check the installed version

    Print the package version.

Set the Run boundary and behavior.

Options belong before the coding task. Repeat an option only where the reference marks it repeatable.

-w, --workspace <path>
Use this Workspace instead of the current directory.
--add-dir <path>repeatable
Grant read and write access to an additional directory outside the Workspace.
--base-url <url>
Set an OpenAI-compatible API endpoint for this Run.
-m, --model <id>
Select an OpenAI-compatible model.
--reasoning <level>
Choose none, low, medium, high, xhigh, or max.
--image <path>repeatable
Attach a PNG, JPEG, WEBP, or GIF to the first prompt.
-c, --config <path>
Load an additional user-controlled JSON configuration file. See the configuration reference for precedence and supported keys.
--max-turns <n>
Set a positive maximum number of model turns for each message.
-y, --yes
Approve ordinary policy prompts, never sandbox exceptions.
-v, --verbose
Show full non-sensitive Action output.
--no-log
Do not write a local Run record.
--no-update
Skip the automatic update check for this invocation.
--version
Print the installed package version.
-h, --help
Show command syntax and all CLI options.

Use slash commands in the interactive prompt.

Start with froe, then press Tab after / to complete an available slash command.

/init

Create a starter AGENTS.md from the observed Workspace structure and tooling.

If a root AGENTS.md already exists, Froe preserves it and reports that check as validation.

/exit

Leave the interactive conversation without starting another Run.

/model <model-id>

Use an OpenAI-compatible model for later messages in this conversation.

/mcp

List the MCP servers that are active in this conversation and how many tools each server contributes.