Choose this lane if you want to trigger plans from your laptop, gate a CI pipeline on Forgecroft results, or let a coding agent (Claude Code, Codex, Cursor) operate Forgecroft on your behalf.
- Getting Started — install, log in, and trigger your first plan
- CI Usage — gate merges on run status from GitHub Actions, GitLab CI, or any shell
- Coding Agents — hand a scoped, short-lived API key to an AI assistant
- Command Reference — every flag, every command
CLI vs Agent — which one do I need?
Forgecroft has two distinct binaries. They do different jobs and should not be confused.
forgecroft (CLI) | forgecroft-agent (self-hosted runner) | |
|---|---|---|
| Who runs it | You, on your laptop or in CI | A long-running process on infra you control |
| What it does | Triggers runs, reads logs, manages keys | Claims queued runs and executes tofu plan / apply |
| Credentials | Your user session or a short-lived onboarding key | An org-scoped runner key you install once |
| When you need it | Always, if you use the API at all | Only for self-hosted execution (agent mode) |
If you only use Forgecroft’s managed execution, you never need forgecroft-agent — the CLI is enough.