APilot

Navigate your APIs. Automatically.

APilot scans your source code, extracts API endpoints, and exports them to the format you need — Postman collections, Markdown docs, cURL commands, and more. No annotations required, no runtime needed.

1 AI Agent Skill

Skill	Description
apilot	Scan source code and export API endpoints to Postman, Markdown, cURL, and more

---

What it does

Point APilot at a source directory and it figures out the rest:

apilot export ./my-service --formatter postman --output collection.json
apilot export ./my-service --formatter markdown --format detailed
apilot export ./my-service --formatter curl

It detects your language and framework automatically, walks the source tree, and produces clean, structured API output — ready to import into Postman, share as docs, or drop into a CI pipeline.

---

Supported languages & frameworks

Language	Frameworks
Java	Spring MVC, JAX-RS, Feign
Go	Gin, Echo, Fiber
Node.js	Express, Fastify, NestJS
Python	FastAPI, Django REST, Flask

---

Output formats

Format	Description
markdown	Markdown docs (simple or detailed)
curl	One curl command per endpoint
postman	Postman Collection v2.1 JSON

---

Quick Start (AI Agent)

The following steps are for AI Agents (Claude Code, Cursor, etc.).

Step 1 — Install

# Install CLI
npm install -g @tangcent/apilot

# Install CLI SKILL (required)
npx skills add tangcent/apilot -y -g

Step 2 — Export APIs

# Scan source code and export to Postman
apilot export ./my-service --formatter postman --output api.postman_collection.json

# Generate Markdown documentation
apilot export ./my-service --formatter markdown --format detailed --output API.md

# Generate cURL commands
apilot export ./my-service --formatter curl

Step 3 — Verify

apilot export --list-collectors
apilot export --list-formatters

---

Installation

npm (recommended)

npm install -g @tangcent/apilot

Download binary

Grab the latest release for your platform from the releases page:

# macOS (Apple Silicon)
curl -L https://github.com/tangcent/apilot/releases/latest/download/apilot-darwin-arm64 -o apilot
chmod +x apilot && sudo mv apilot /usr/local/bin/

Build from source

git clone https://github.com/tangcent/apilot.git
cd apilot
go build -o apilot ./apilot-cli

Install from source (local development)

Use the install script to build and install apilot to your local PATH — handy for testing changes before release:

# Clone and enter the repo
git clone https://github.com/tangcent/apilot.git
cd apilot

# Build and install to /usr/local/bin (or ~/.local/bin if no write access)
./scripts/install-local.sh

# Or specify a custom install directory
./scripts/install-local.sh /usr/local/bin

# Verify
apilot --version

After making code changes, just re-run ./scripts/install-local.sh to rebuild and reinstall.

---

Usage

apilot export <source-path> [flags]

  source-path can be a directory or a single source file.
  When a file is given, the project root is auto-detected by walking up
  to find pom.xml, build.gradle, go.mod, package.json, etc.
  For multi-module projects, the topmost directory with an indicator is used.

Flags:
  --collector      string   Collector name (auto-detected if omitted)
  --formatter      string   Output format: markdown, curl, postman (default: markdown)
  --format         string   Format variant, e.g. simple, detailed (default: simple)
  --method         string   Filter to a specific method name (used with file-level export)
  --project-root   string   Override auto-detected project root directory
  --output         string   Output file path (default: stdout)
  --list-collectors         Print available collectors and exit
  --list-formatters         Print available formatters and exit

Examples

# Export a Spring Boot project to Postman
apilot export ./backend --formatter postman --output api.postman_collection.json

# Generate detailed Markdown docs
apilot export ./backend --formatter markdown --format detailed --output API.md

# Quick cURL reference to stdout
apilot export ./backend --formatter curl

# Export all APIs from a specific file
apilot export UserController.java --formatter markdown

# Export a single method from a file
apilot export UserController.java --method getUser --formatter curl

# Multi-module project: override project root
apilot export user-service/src/.../UserController.java --project-root ./company-platform

Three levels of granularity

Command	Scope
apilot export ./project	All APIs in project
apilot export UserController.java	All APIs in that file
apilot export UserController.java --method getUser	One specific API

---

IDE integrations

• VSCode — via the APilot VSCode extension (right-click any folder to export)
• JetBrains — see easy-api for the IntelliJ plugin

---

Extending APilot

APilot has a plugin system. Any binary that speaks the stdin/stdout JSON protocol can be registered as an external collector or formatter — no recompilation needed.

// ~/.config/apilot/plugins.json
{
  "plugins": [
    {
      "name": "rust",
      "type": "collector",
      "command": "apilot-collector-rust"
    }
  ]
}

See docs/plugin-protocol.md for the full protocol spec.

---

Architecture

APilot is a multi-module Go monorepo with a clean three-layer design:

apilot-cli  (bundled binary)
  └── api-master  (engine + plugin runtime)
        ├── api-collector-{java,go,node,python}
        └── api-formatter-{markdown,curl,postman}

The api-collector and api-formatter packages define the stable interfaces. Everything else is an implementation. See docs/architecture.md for the full breakdown.

---

Contributing

PRs and issues are welcome. See CONTRIBUTING.md to get started.

---

License

MIT