Getting Started

What is apix?

apix is a Rust CLI that converts monolithic OpenAPI specs into a file-system-native markdown vault. It lets you discover, browse, search, and execute API calls — designed for both AI agents and human developers.

Agent-native by design

When piped, apix outputs raw markdown — optimized for LLM context windows. Agents can follow the search → peek → call loop with minimal token overhead.

Installation

curl -fsSL https://apix.sh/install | sh

Pin a specific version:

curl -fsSL https://apix.sh/install | sh -s -- --version v0.1.0

brew install apix-sh/tap/apix

Requires Rust toolchain (rustup, cargo).

cargo install apix-cli

Verify the installation:

apix --version

Install Agent Skill

Give your AI coding agents the ability to use apix directly in your workspace.

Works with Cursor, Claude Code, Codex CLI, and more via skills.sh: bash npx skills add apix-sh/cli

Install via ClawHub: bash npx clawhub@latest install apix

Quick Start

Search the registry

Find APIs matching your needs:

apix search stripe

Pull an API vault

Download only the API you need via sparse Git checkout:

apix pull stripe

Browse endpoints

List available routes and peek at parameters:

apix ls stripe/v1
apix peek stripe/v1/charges/POST

Make a call

Execute an API request directly:

apix call stripe/v1/charges/POST \
  -H "Authorization: Bearer $STRIPE_KEY" \
  -d '{"amount":2000,"currency":"usd"}'

Next Steps

Core Concepts

Learn about vaults, sources, routes, and progressive disclosure.

Command Reference

Full reference for every apix command.

Configuration

Customize apix behavior, sources, and environment.

Getting Started

Core Concepts

Command Reference

Configuration

On this page