Skip to content

Installation

CmdForge runs on Python 3.10 or newer. The command-line tools and desktop builder install together; optional extras add MCP, interactive PTY providers, and the registry web stack.

A Clean Personal Installation

pipx keeps CmdForge isolated while placing cmdforge and cf on your path:

pipx install 'cmdforge[mcp,pty]'
cmdforge --version
cmdforge --help

A normal virtual environment works just as well:

python3.10 -m venv .venv
. .venv/bin/activate
python -m pip install 'cmdforge[mcp,pty]'

Choose Only the Extras You Need

InstallAdds
cmdforgeCLI, desktop GUI, contracts, registry client, and local tool runner
cmdforge[mcp]MCP client steps and MCP server integration
cmdforge[pty]Interactive pseudo-terminal providers
cmdforge[mcp,pty]The recommended personal installation with agent integration
cmdforge[all]Every optional feature, including the registry web-server stack

Let CmdForge Inspect the Machine

cmdforge providers discover
cmdforge providers discover --add
cmdforge providers list

Discovery recognizes supported coding CLIs, API-key environment variables, and Ollama models. The built-in mock provider lets you test structure before authenticating a real engine.

Run a Smoke Test

cmdforge create hello --prompt "Reply with a short greeting to {input}"
echo "Ada" | cmdforge run hello --provider mock
cmdforge inspect hello

If wrapper commands are not on your shell path, add ~/.local/bin or run the explicit cmdforge run NAME form.

Install for Development

git clone https://gitea.brrd.tech/rob/CmdForge.git
cd CmdForge
python -m pip install -e '.[all,dev]'
pytest tests/ -m "not integration"

Continue with Your First Tool, or connect a coding host through MCP.