Skip to main content

Deployment

Environment​

ForgeFlow requires Python >= 3.13 and tmux.

# Clone
git clone https://github.com/Kingson4Wu/ForgeFlow
cd ForgeFlow

# Install
uv sync          # or: pip install -e .

tmux​

Ensure tmux is installed and on PATH:

brew install tmux  # macOS
# or
apt install tmux   # Linux

AI CLI Tools​

Install at least one supported AI CLI:

CLIInstall
Claude Codenpm install -g @anthropic/claude-code
Geminipip install google-gemini
Codexpip install openai-codex

Long-Running Tasks​

To prevent Mac from sleeping during long tasks:

caffeinate forgeflow --session my_session --workdir "/path/to/project" --ai-cmd "claude"

Running​

forgeflow --session my_session --workdir "/path/to/project" --ai-cmd "claude --dangerously-skip-permissions" --cli-type claude_code

Or with uv run:

uv run forgeflow --session my_session --workdir "/path/to/project" --ai-cmd "claude"

Documentation Site​

cd documentation
npm install
npm run start     # development
npm run build     # production build
npm run serve     # serve production build

Run forgeflow --help for the full CLI reference.