Skip to content

onboarding

Scan and install local provider CLIs for Clanker Cloud onboarding.

The onboarding command is the local setup contract for Clanker Cloud and MCP agents. It detects installed tools, local credential signals, missing provider dependencies, and the next official authentication steps before an agent asks the user to install anything.

Usage

bash
clanker onboarding [command]

Commands

CommandDescription
scanScan local provider CLIs and detected provider context
installInstall missing provider CLIs using allowlisted platform commands
agent-promptPrint setup instructions for a local agent

Scan

bash
clanker onboarding scan
clanker onboarding scan --provider aws,gcp,azure,kubernetes --format json
clanker onboarding scan --provider cloudflare --provider digitalocean

scan reports provider readiness, installed tools, missing tools, recommended installs, official docs URLs, auth commands, and token/account URLs. Use --format json when an agent or Clanker Cloud setup flow will parse the result.

FlagTypeDefaultDescription
--providerstringsemptyProvider or workflow the user wants to use. Can be comma-separated or repeated
--formatstringtextOutput format: text or json

Install

bash
clanker onboarding install --dry-run --provider aws,gcp,azure,kubernetes
clanker onboarding install --yes aws gcloud az kubectl
clanker onboarding install --yes --provider cloudflare

install only runs allowlisted install commands for selected or detected providers. If no tool names are passed, Clanker chooses missing tools from the scan result and --provider selection.

FlagTypeDefaultDescription
--providerstringsemptyProvider or workflow the user wants to use
--dry-runboolfalsePrint install commands without running them
--yesboolfalseRun install commands without interactive confirmation
--timeoutstring20mTimeout per install command
--formatstringtextOutput format: text or json

Supported tools include aws, gcloud, az, wrangler, doctl, hcloud, kubectl, gh, railway, supabase, vercel, flyctl, terraform, opentofu, and docker.

Agent Workflow

For Clanker Cloud setup, agents should:

  1. Run clanker onboarding scan --format json.
  2. Ask which providers to set up if none are selected or detected.
  3. Run clanker onboarding install --yes <tool> only for selected or detected providers.
  4. Run clanker onboarding scan --format json again.
  5. Use the returned official docs, login commands, and token URLs for any browser login, SSO, sudo, or API-token step.

See Also