Command Reference
Every EdgeProof command, what it does, and its flags. Run edgeproof --help for a short version, or edgeproof <command> --help where supported.
Global
| Command | Description |
|---|---|
edgeproof --version |
Print the installed version and exit |
edgeproof --help |
List available commands |
Setup and health
edgeproof init
Interactive first-time setup wizard. Probes your LLM, Alpaca account, and Discord source, then writes a .env (0600 permissions) in the current directory. Never asks for a license key. See Install.
edgeproof doctor
Run all system health checks and print a report. Exit code 0 = all pass, 1 = warnings, 2 = failures. A fresh unconfigured machine shows config.load: fail until you run init.
| Flag | Effect |
|---|---|
--json |
Emit the report as JSON (schema version 1) instead of text. Useful for scripting. |
edgeproof doctor
edgeproof doctor --json > report.json
Running the supervisor
edgeproof start
Start all trading roles under the supervisor: monitor, positions, ledger, and (in bot mode) discord. Runs a preflight health check first and refuses to start if it fails.
| Flag | Effect |
|---|---|
--skip-preflight |
Start without running preflight checks. Prints a warning. Use only when you have already verified health with doctor. |
edgeproof status
Show live supervisor status: which roles are running, their PIDs, and the current halt state.
edgeproof stop
Stop the supervisor and all roles gracefully. Handles stale PID files, so it is safe to run even after a crash.
Risk controls
edgeproof halt
Pause new trade entries within one monitor cycle. Open positions continue to be managed and exits still fire. No restart needed.
| Flag | Effect |
|---|---|
--reason "<text>" |
Record a reason for the halt, shown in status and logs. |
edgeproof halt --reason "stepping away for lunch"
edgeproof resume
Resume trade entries after a halt.
edgeproof flatten
Place market orders to close all open positions, then halt entries. Use this before going offline for an extended period. This sells real positions in live mode.
Licensing
edgeproof license activate <KEY>
Activate a live-trading license. The key looks like EP-XXXX-XXXX-XXXX-XXXX. Stores a signed token locally; the key is masked in all output.
edgeproof license status
Show your plan, days until expiry, and last refresh time.
edgeproof license refresh
Force a token refresh from edgeproof.net instead of waiting for the automatic daily refresh. Useful right after renewing. See Licensing.
Dashboard
edgeproof dashboard
Serve the local ledger dashboard at http://127.0.0.1:3030: open positions, filled orders, daily P&L, and tournament scores. Bound to localhost only.
| Flag | Effect |
|---|---|
--port <n> |
Serve on a different port. Also settable with LEDGER_PORT. |
edgeproof dashboard --port 3999
Environment flags
Some behavior is controlled by environment variables rather than flags:
| Variable | Effect |
|---|---|
EDGEPROOF_NO_UPDATE_CHECK=1 |
Disable the daily version check |
LEDGER_PORT |
Default dashboard port |
LICENSING_WORKER_BASE_URL |
Override the license server (testing) |
See the full Config reference for every variable.
Exit codes
| Code | Meaning |
|---|---|
0 |
Success, or all health checks passed |
1 |
Warnings present (doctor), or a handled error |
2 |
Health-check failures (doctor, or preflight before start) |
Note: flags such as --once, --dry-run, and --bypass-trading-hours exist on the internal role processes the supervisor spawns. They are for development and testing, not part of the supported user-facing surface.