Install & initialize
This guide gets you from zero to a scaffolded Molar project connected to your workspace.
Prerequisites
- Node.js 22+ (for
npx) or the nativemolarbinary from get.molar.it - A GitHub account (optional now; required for PR gating later)
- Your app's URL for Cartographer crawl (optional at signup; add anytime)
Step 1 — Create an account
Human signup (default)
- Go to app.molar.it and sign up.
- Complete onboarding — create a project and optionally enter your app URL.
- Invite teammates from Settings → Members.
Agent self-serve (coding agents)
If an AI agent is setting up Molar without a pre-existing account, use Agent self-serve signup. The agent registers via API or molar agent signup, your team receives a 6-digit verification email, and full MCP scopes unlock after verify. If signup returns 503, use human signup + a dashboard PAT instead. Humans still own billing and org settings at app.molar.it.
Step 2 — Install the CLI
npx molar-agent init
molar-agent is a thin alias over @molar/cli — every subcommand matches molar <subcommand>.
| Method | Command |
|---|---|
| npx | npx molar-agent --help |
| npm | npm install -g @molar/cli |
| Homebrew | brew tap molar-it/tap && brew install molar |
| curl | curl -fsSL https://get.molar.it | sh |
Verify: molar version and molar doctor.
Note:
molar doctor checks for the Guard runner (@molar/guard-runner / molar-guard binary). Local molar run needs it. Cloud runs from the dashboard do not require a local runner.
Step 3 — Initialize a project
npx molar-agent init
# or: molar init [path]
Creates:
.molar/
scenarios/
config.toml
.gitignore
Also writes .cursorrules and AGENTS.md for AI-assisted authoring.
Step 4 — Connect to Molar Cloud
- Settings → API Tokens → create a PAT.
- Export locally:
export MOLAR_API_URL=https://api.molar.it
export MOLAR_TOKEN=molar_pat_xxxxxxxx
Or ~/.config/molar/config.toml:
api_url = "https://api.molar.it"
token = "molar_pat_xxxxxxxx"
Note:
molar login --token molar_pat_xxxx validates and saves credentials. There is no separate molar whoami command — use GET /api/v1/me with your token.
Step 5 — Connect your app
- Open app.molar.it.
- Ensure your Cartographer project has your app URL (set during onboarding or in the Cartographer dashboard).
- Use Scouts or MCP to discover flows, then approve them as scenarios under Scenarios.