chowbea-axios
Commands

status

Show current state of your API client setup.

The status command displays a comprehensive overview of your chowbea-axios configuration, cached spec, and generated files.

Usage

chowbea-axios status [flags]

What It Shows

  1. Config - Location and key settings
  2. Spec - Cache status, hash, and age
  3. Endpoints - Count and breakdown by HTTP method
  4. Generated files - Status and last modified time
  5. Client files - Which editable files exist

Flags

FlagShortDescriptionDefault
--config-cPath to api.config.tomlAuto-detected
--quiet-qSuppress non-error outputfalse
--verbose-vShow detailed outputfalse

Example Output

╭──────────────────────────────────────────────────
│ Status
├──────────────────────────────────────────────────

│ Config: api.config.toml
│   endpoint: http://localhost:3000/docs/swagger/json
│   output: app/services/api

│ Spec:
│   cached: yes (hash: a1b2c3d4, 5 min ago)
│   endpoints: 42 total
│     GET: 18  POST: 12  PUT: 6  DELETE: 4  PATCH: 2

│ Generated:
│   types: yes (5 min ago)
│   operations: yes (5 min ago)

│ Client files:
│   all present
╰──────────────────────────────────────────────────

Status Breakdown

Config Section

Shows your configuration file location and key settings:

│ Config: api.config.toml
│   endpoint: http://localhost:3000/docs/swagger/json
│   output: app/services/api

If the config was just created, you'll see (created):

│ Config: api.config.toml (created)

Spec Section

Shows cache status and endpoint statistics:

│ Spec:
│   cached: yes (hash: a1b2c3d4, 5 min ago)
│   endpoints: 42 total
│     GET: 18  POST: 12  PUT: 6  DELETE: 4  PATCH: 2

If no spec is cached:

│ Spec:
│   cached: no - run 'chowbea-axios fetch' first

Generated Section

Shows the status of auto-generated files:

│ Generated:
│   types: yes (5 min ago)
│   operations: yes (5 min ago)

Or if not generated:

│ Generated:
│   types: no
│   operations: no

Client Files Section

Shows which editable client files exist:

│ Client files:
│   all present

If some are missing:

│ Client files:
│   helpers: yes (2h ago)
│   instance: yes (2h ago)
│   error: missing
│   client: missing

Use Cases

Verify Setup

After running init, check that everything was created:

chowbea-axios status

Debug Issues

If something isn't working, status shows the current state:

chowbea-axios status --verbose

CI/CD Verification

Check that types are generated before building:

chowbea-axios status
# Check exit code or parse output

Next Steps

On this page