Authentication

API keys for CLI cloud features. Not required for local-only usage.

When You Need an API Key

An API key is only required for cloud features: the --cloud flag on convert, cloud-side linting, and skill catalog access via the API. Local conversion, local linting, and GitHub-based skill installation work without any authentication.

Get Your API Key

1

Sign in to migrateforce.com

2

Go to Settings → API Keys

3

Click "Generate API Key" — copy the key (shown once)

Configure the CLI

# Interactive login (stores key in ~/.migrateforce/config.json)
npx @migrateforce/cli auth login

# Or set via environment variable
export MIGRATEFORCE_API_KEY=mf_sk_your_key_here

Verify

npx @migrateforce/cli auth status

Shows your key status, scopes, and rate limit usage.

Key Scopes

ScopeAllows
convertSend specs for cloud analysis, receive enrichments
lintRun cloud-side linting and readiness scoring
skillsSearch and read from the skill catalog API
Default keys include all scopes
Keys generated from the dashboard have all three scopes enabled. Contact support if you need restricted-scope keys for CI environments.

Next: Local vs Cloud — understand what the API key unlocks when you add --cloud to your convert command.