CLI

See the CLI command reference for every released command and flag.

Install the current CLI on macOS or Linux:

curl -fsSL https://raw.githubusercontent.com/micro-so/micro-cli/main/scripts/install.sh | bash

The v1.0.0 binary is cli. Authenticate scripts with CLI_API_KEY and pass the workspace ID to data commands:

export CLI_API_KEY="$MICRO_API_KEY"

cli query \
  --team-id "$MICRO_TEAM_ID" \
  --object-type contact \
  --query '{"select":["full_name","email"],"limit":25}' \
  --output-format json

Use cli --help or append --help to a command for released flags. The CLI supports pretty, json, yaml, table, and token-efficient toon output. Use --jq to filter structured output and --dry-run to preview a supported command without making a network call.

For unattended work, add --no-interactive. --agent-mode selects structured errors and agent-friendly defaults. Use environment variables instead of command-line secrets, choose a structured output format, and keep diagnostics on stderr separate from responses.