cli

README

Intercube CLI

This command line interface allows you to connect, manage, and synchronize data from your Intercube cubes (servers).

Onboarding

Use the onboarding command to set up your CLI config interactively:

intercube onboarding

The wizard can help you:

• configure login defaults (username, password, scope, auth_method, instance_url)
• optionally configure file path mappings for intercube sync
• verify local prerequisites such as Boundary CLI and rsync

After onboarding, use:

intercube ssh

If required settings are missing (or the config file does not exist), the CLI will prompt only when needed and save values automatically:

• intercube ssh prompts for required login settings
• intercube sync prompts for missing file path mappings
• intercube map --interactive prompts to create mappings when none exist

intercube login is kept as a deprecated alias and prints a warning to use intercube ssh.

Sync

Use sync from a source environment host:

intercube sync
intercube sync staging.example.com
intercube sync --files
intercube sync --database
intercube sync --dry-run

Behavior:

• always fetches current site inventory at runtime
• interactive target selection when no argument is passed
• argument auto-resolves against site ID/domain/server/user when possible
• stores only file path mappings in config (sync.files.items)
• database details are requested interactively for each run (not persisted)

Context-aware defaults

The CLI resolves defaults using context detection and a fixed precedence.

Context detection order:

1. --context / INTERCUBE_CONTEXT (pipeline, server, repository, global)
2. CI=true -> pipeline mode
3. server config at /etc/intercube.yaml -> server mode
4. nearest repo containing .intercube.yaml -> repository mode
5. fallback -> global mode

Resolution precedence:

1. command flags
2. environment variables
3. active context config
4. user defaults

Supported default keys:

context:
  org_id: org_xxx
  site_id: "58"
  server_id: "42"

behavior:
  non_interactive: false

Config scopes:

• user: ~/.intercube.yaml
• repository: <repo>/.intercube.yaml
• server: ~/.intercube.yaml (same user-level config, used when --context server is selected)

Environment overrides:

• INTERCUBE_ORG_ID (preferred) and INTERCUBE_ORGANIZATION_ID (legacy)
• INTERCUBE_SITE_ID
• INTERCUBE_SERVER_ID
• INTERCUBE_NON_INTERACTIVE

In non-interactive mode, commands fail instead of prompting when required values are missing.