Skip to content

TidalStudio/api-docs-cli

Repository files navigation

api-docs-cli logo

API Docs CLI

A CLI for discovering and extracting API documentation from any source.

npm version Node.js version License CI Code style: prettier

Why this tool? API documentation is scattered across different formats and frameworks. This CLI gives you instant access to any API's endpoints—just provide a name or URL.

Installation

npm install -g @tidalstudios/api-docs-cli

Or run directly with npx:

npx @tidalstudios/api-docs-cli endpoints stripe

Quick Start

# List endpoints from any API provider
api-docs endpoints stripe

# Or from a direct URL
api-docs endpoints https://docs.n8n.io/api

# Get details for a specific endpoint
api-docs endpoint stripe /v1/customers --method GET

# View cached specs
api-docs list

Features

  • Universal Discovery - Find APIs by provider name via APITracker.io
  • Multi-Framework Support - Swagger UI, Redoc, Scalar, and generic docs
  • Smart Extraction - Automatic fallback through multiple strategies
  • Spec Caching - Local cache with TTL for fast repeated access
  • Clean Output - Color-coded, grouped endpoints

Commands

Command Description
endpoints List all endpoints from an API
endpoint Get details for a specific endpoint
fetch Fetch and cache an API spec
list List cached API specs
clear Clear cached specs

AI Agent Integration

Works as a Claude Code subagent:

Task(subagent_type="api-docs", prompt="List endpoints for the Stripe API")

Documentation

For detailed documentation, see the Wiki:

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published