Skip to content
Crucible

Quick Start

1. Install Forge

Section titled “1. Install Forge”
Terminal window
bun add -g @crucibledx/forge-cli

2. Initialize in your project

Section titled “2. Initialize in your project”
Terminal window
cd your-project
forge init

The wizard will:

  • Detect AI assistants — scans for .claude/, .cursor/, .windsurf/, .github/copilot-instructions.md, .cline/
  • Configure a source — choose git (remote repo URL) or local (path on disk)
  • Write config — creates .crucible/forge.config.yaml

3. Sync

Section titled “3. Sync”
Terminal window
forge sync

Forge fetches from your configured source, resolves target paths for each AI assistant, applies transforms (e.g., .md → .mdc for Cursor), and places files.

Preview first

Section titled “Preview first”
Terminal window
forge sync --dry-run

See what would change without writing anything.

4. Check status

Section titled “4. Check status”
Terminal window
forge status

Shows drift between the last sync state and your current filesystem:

  • in-sync — file matches last sync
  • modified — locally changed since last sync
  • deleted — removed from disk but still in sync state
  • remote-updated — changed in source since last sync
  • new-in-source — exists in source but not yet synced

5. Set up auto-sync (optional)

Section titled “5. Set up auto-sync (optional)”
Terminal window
forge scheduler install

Registers an OS-level scheduled task:

  • macOS — launchd
  • Linux — crontab
  • Windows — Task Scheduler

Default schedule: every 30 minutes. Configurable via cron expression in forge.config.yaml.

The engineer’s journey

Section titled “The engineer’s journey”

Engineer Journey

What’s next

Section titled “What’s next”