Guides
Documentation
The command-line tool

CLI commands

Everything the command-line tool can do, grouped by what you're trying to do.

Here's everything the tool can do, grouped by what you're trying to do — set it up, run it, check on it, and clean up. Run any command followed by --help to see its details.

Set up

fragua login

Connect this computer to your Fragua account by storing your agent token. Run it on its own and it asks for the token, or pass it in.

Options: --token to pass the token, --base-url for a self-hosted Fragua, --name to label this computer, --concurrency to set how many agents run at once.

fragua doctor

Check that everything's ready — Claude, git, the GitHub CLI, and the connection to Fragua — and point out anything missing.

Options: --json for machine-readable output.

fragua version

Show the installed version of the tool.

Run it

fragua agent

Run the worker in your terminal. It connects, picks up work, and runs agents until you stop it — handy for a quick test.

fragua agent install

Install the worker as a background service that starts when you log in and restarts itself if it stops. The usual way to run it day to day.

fragua agent start

Start the background service now.

fragua agent stop

Stop the background service, leaving it installed.

fragua agent status

Show whether the background service is installed and currently running.

fragua agent uninstall

Remove the background service. Your settings and token stay in place.

Check on it

fragua status

Show this computer's name, the workspaces it's handling, and its settings — all read locally, no connection needed.

Options: --check to also test the connection to Fragua, --json for machine-readable output.

fragua logs

Show recent activity from the background service.

Options: -n to set how many lines, --errors to show only problems, --file to read a specific log file.

Clean up

fragua prune

Remove local copies of workspaces Fragua no longer manages. It refuses to touch anything with unsaved or unpushed work.

Options: --yes to skip the confirmation prompt.

fragua logout

Remove the stored token from this computer. Your settings stay; you'll need to log in again to reconnect.

Not sure what a command takes? Run it with --help — for example, fragua agent --help.

New to the tool?

The quick start walks through installing and connecting it step by step.

Open the quick start