Skip to main content

Usage

codika-helper status [path] [options]

Arguments

ArgumentDescription
[path]Path to check (defaults to current directory)

Options

OptionDescription
--jsonOutput as JSON
--verifyRun quick validation on the detected use case

Output sections

Identity

Shows the current authenticated state:
Identity:
  Status:       Logged in
  Organization: Acme Corp
  Profile:      acme-corp
  Key:          cko_abc...xyz

Use case context

If a use case folder is detected at the path:
Use Case:
  Detected:     ✓
  Title:        Email Automation
  Version:      1.2.3
  Workflows:    3
  Project ID:   abc123
  Profile:      ✓ match (acme-corp)

Profile match status

StatusMeaning
matchActive profile’s org matches project.json org — ready to deploy
mismatchDifferent org — shows suggested profile to switch to
no-org-in-projectNo organizationId in project.json
no-profileNot logged in

Readiness

Shows whether the use case is ready to deploy:
Readiness:
  ✓ Ready to deploy
Or with issues:
Readiness:
  ✗ Not ready to deploy
    - No project.json found
    - Profile org does not match project org (try: codika-helper use staging)

Warnings

  • Profile mismatch: “Active profile ‘acme-corp’ does not match project org. Suggested: ‘staging’”
  • Key expiry < 7 days: “API key expires in 3 days”
  • Key expired: “API key has expired”

Examples

# Check status in current directory
codika-helper status

# Check a specific directory
codika-helper status ./email-automation

# Check with validation
codika-helper status ./email-automation --verify

# Machine-readable output
codika-helper status --json

Exit codes

CodeMeaning
0Ready to deploy
1Not ready (issues found)