Installation
Install chowbea-axios globally or use it directly with npx.
Prerequisites
- Node.js version 18 or higher
- A project with
package.json - An OpenAPI specification (v3.x) endpoint or file
Installation Options
Global Installation (Recommended)
Install globally to use chowbea-axios anywhere:
npm install -g chowbea-axiosyarn global add chowbea-axiospnpm add -g chowbea-axiosbun add -g chowbea-axiosAfter installation, verify it works:
chowbea-axios --versionUsing npx (No Installation)
Run commands directly without installing:
npx chowbea-axios init
npx chowbea-axios fetch
npx chowbea-axios watchUsing npx downloads the package on first use, so subsequent runs are faster.
Dependencies
chowbea-axios automatically installs axios in your project during init. No manual installation required.
The CLI uses openapi-typescript under the hood for type generation, accessed via pnpm dlx (no direct dependency needed).
Verify Installation
Run the status command to check everything is working:
chowbea-axios statusIf you haven't set up a project yet, you'll see:
╭────────────────────────────────────────
│ Status
├────────────────────────────────────────
│
│ Config: api.config.toml (created)
│ endpoint: http://localhost:3000/docs/swagger/json
│ output: app/services/api
│
│ Spec:
│ cached: no - run 'chowbea-axios fetch' first
╰────────────────────────────────────────