Home

What is apijack

apijack is a framework for generating full-featured CLIs from OpenAPI specs. It produces typed API clients, Commander-based command trees, and supports AI-agentic workflow automation via YAML routines and MCP server integration.

Who is this for

• CLI users — people using a generated CLI to interact with APIs, write routines, and automate workflows
• Developers — people building their own CLIs with the apijack framework, configuring auth strategies, and extending with custom commands

Start here

Pick the path that matches what you're doing:

I want to use a CLI that someone built with apijack → Quickstart → Managing Environments → Writing Routines

I want to build a CLI for my own API → Building a CLI → Authentication Strategies → Project Mode

I want to author routines and need detail on a specific feature → jump straight to Variables, Output Capture, Conditions & Assertions, Loops, Error Handling, or Sub-Routines

I want to see an end-to-end example → Petstore Example App

Install

bun install -g @apijack/core

or

npm install -g @apijack/core

Using a CLI

• Managing Environments
• Command Discovery

Authoring routines

• Writing Routines — overview and full example
• Variables — $var, $_env, $_find, $_random_*
• Output Capture — chaining steps via $alias.field
• Conditions & Assertions — branching and validation
• Loops — forEach, range, with six worked examples
• Error Handling — continueOnError patterns
• Sub-Routines & Meta-Commands — composition, wait-until, session refresh
• Routine Testing

Building a CLI

• Building a CLI
• Authentication Strategies
• Session Auth
• Project Mode
• MCP Server Integration
• Code Generation Internals

Reference

• CLI Command Reference
• Routine YAML Schema
• OpenAPI Compatibility
• Authentication Configuration
• Recommended Gitignore