CLI reference

This page documents every command supported by the forgebench CLI. Most users only need forgebench setup, described in Getting started. Refer to this page for commands and flags beyond that basic setup.

Getting help

Every command below also supports --help, which lists the same flags documented here.

forgebench --help
forgebench run --help

To check the installed version, run forgebench --version.

Setup

Guided, opt-in setup. Run it with no flags for the keyboard-driven flow described in Getting started: choose the ForgeBench URL, sign in, pick tools and a history window, review the local preview, then approve sync and upload.

# Guided setup
forgebench setup

# Ask about automatic sync and the first upload separately
forgebench setup --advanced

# Non-interactive: sign in first, then configure one tool and upload
forgebench login
forgebench setup --tool claude_code --since 30d --install-hooks --sync-now

Run

Parses local session logs, scores them, and optionally submits the result. This is the base command that other commands build on.

# First run: process all historical sessions and submit the result
forgebench run --all --push

# Daily check: local only, nothing submitted
forgebench run --since 24h

Login / logout

# Sign in through a browser (also available inside setup)
forgebench login

# On a remote machine without browser access, sign in with a key provided by an administrator
forgebench login --key

# Remove the stored key from this machine
forgebench logout

Schedule

Runs run --all on a recurring interval, so reporting does not depend on running the command manually.

# Run automatically once a day
forgebench schedule enable --interval daily

# Disable the schedule
forgebench schedule disable

Sync

The command the session-end hook runs internally. It is not normally run directly; it is documented here for completeness and is useful for running a hook's exact command manually if the hook appears to be stuck.

forgebench sync --quiet

Hooks

Enables automatic reporting whenever a session ends. This is the recommended, set-and-forget configuration and is the option used in Getting started.

# Enable automatic reporting
forgebench hooks install

# Also report after every response, not only when a session ends
forgebench hooks install --on-stop

# Only one tool (repeat --tool to pick several)
forgebench hooks install --tool codex
forgebench hooks install --tool opencode

# Check whether the hook is enabled and when it last ran
forgebench hooks status

# Disable automatic reporting
forgebench hooks uninstall

# Disable it for one tool only
forgebench hooks uninstall --tool claude_code

Status

Displays a summary of the current state: installed version, sign-in status, whether the hook is installed, and whether a schedule is running.

forgebench status

Update

Checks whether a newer version is available and prints the install command to run. This command does not install the update itself, since a running program cannot safely replace itself while executing, particularly on Windows.

# Check the stable channel (the default unless the preview channel was selected)
forgebench update

# Check the preview channel instead
forgebench update --channel preview

Uninstall

Removes the schedule, the hook, and the stored login: everything the CLI can safely remove on its own. It then prints the command to remove the program itself.

forgebench uninstall

Next