Skip to main content

CLI Reference

Complete reference for all Odin CLI commands

Complete reference for all Odin CLI commands and flags.

Global Flags

All commands inherit these flags:

Flag Short Default Description
--profile -p default Profile to use from ~/.odin/config
--output -o text Output format (text or json)
--verbose -v false Enable verbose logging

odin configure

Configure Odin locally and authenticate with the backend.

odin configure [flags]

Flags

Flag Required Description
--backend-address Yes* Host:port of the Odin backend
--org-id Yes* Organization identifier
--insecure / -I No Skip TLS host verification
--plaintext / -P No Use plaintext gRPC (no TLS)

*Required if not set via environment variables or config file

Examples

# Basic configuration
odin configure --backend-address api.odin.example.com:443 --org-id 12345

# Local development (plaintext)
odin configure --backend-address localhost:8080 --org-id 1 --plaintext

# Configure different profile
odin configure --profile staging \
  --backend-address staging.odin.example.com:443 \
  --org-id 12345

odin create env

Create a new environment.

odin create env <name> [flags]

Arguments

Argument Required Description
name Yes Environment name

Flags

Flag Required Description
--accounts Yes Comma-separated list of provider accounts

Examples

# Create development environment
odin create env dev --accounts aws/dev

# Create staging with multiple accounts
odin create env staging --accounts aws/dev,aws/shared

# Create production environment
odin create env production --accounts aws/prod,aws/shared-services

odin delete env

Delete an existing environment.

odin delete env <name>

odin list env

List all environments you have access to.

odin list env [flags]

Flags

Flag Description
--account Filter by provider account
--all Include environments from other users

odin describe env

Get detailed information about an environment.

odin describe env <name> [flags]

Flags

Flag Description
--service Filter by service name
--component Filter by component name (requires --service)

odin status env

Check the deployment status of an environment.

odin status env <name> [flags]

odin deploy service

Deploy a service to an environment.

odin deploy service [flags]

Flags

Flag Required Description
--env Yes Environment name
--file Yes Service definition JSON file
--provisioning Yes Provisioning configuration JSON file

odin undeploy service

Remove a service from an environment.

odin undeploy service <name> --env <env-name>

odin operate service

Execute operations on a service.

odin operate service --name <name> --env <env> --operation <op> [flags]

Operations

  • redeploy - Redeploy with new configuration
  • ADD_COMPONENT - Add a new component
  • REMOVE_COMPONENT - Remove an existing component

odin operate component

Execute operations on a specific component.

odin operate component --name <name> --service <svc> --env <env> --operation <op>

Operations

  • scale - Scale component replicas
  • restart - Rolling restart
  • update-config - Update configuration

Related Documentation