chowbea-axios
Commands

Commands Overview

Reference for all chowbea-axios CLI commands.

chowbea-axios provides seven commands for managing your API client generation workflow.

Command Summary

CommandPurposeWhen to Use
initFull project setupFirst time setup, adding to new project
fetchFetch spec + generateWhen API changes, CI/CD pipelines
generateGenerate from cacheQuick regeneration, local spec files
watchContinuous pollingDuring development
statusShow current stateDebugging, verification
validateCheck spec qualityBefore deployment, debugging issues
diffPreview changesBefore updating, reviewing API changes

Typical Workflow

Initial Setup

# Run once to set up your project
chowbea-axios init

During Development

# Start watch mode alongside your dev server
chowbea-axios watch

# Or manually fetch when needed
chowbea-axios fetch

Before Deployment

# Validate spec quality
chowbea-axios validate --strict

# Preview what would change
chowbea-axios diff

# Generate fresh types
chowbea-axios fetch --force

Common Flags

These flags are available on most commands:

FlagShortDescription
--config-cPath to custom config file
--quiet-qSuppress non-error output
--verbose-vShow detailed output

NPM Scripts

After running init, these scripts are added to your package.json:

package.json
{
  "scripts": {
    "api:fetch": "chowbea-axios fetch",
    "api:generate": "chowbea-axios generate",
    "api:watch": "chowbea-axios watch",
    "api:status": "chowbea-axios status",
    "api:validate": "chowbea-axios validate",
    "api:diff": "chowbea-axios diff"
  }
}

Use them with your package manager:

npm run api:fetch
pnpm api:watch
yarn api:status

Detailed Documentation

On this page