SuperDocs CLI 🚀

SuperDocs CLI is the magic wand for SuperDocs.cloud. It allows you to generate beautiful, full-stack API and project documentation directly from your terminal using advanced AI.

Installation

npm install -g superdocs-cli

Quick Start

1. Login

Authenticate with your SuperDocs account.

superdocs login
# You will be prompted to paste your Access Token from superdocs.cloud/settings

2. Initialize

Run this in the root of your project:

superdocs init
# Creates a superdocs.json configuration file

3. Generate Docs

Sit back and watch the magic happen:

superdocs generate

The CLI will compress your source code (ignoring private files), send it to the SuperDocs AI Engine, and return a link to your live documentation site.

Configuration

The superdocs.json file allows you to customize the process:

{
  "name": "my-awesome-project",
  "ignore": [
    "node_modules",
    "dist",
    "test",
    "internal"
  ]
}

Features

• Smart Scanning: Automatically ignores secure/private patterns.
• AI Planning: Architects a perfect documentation structure for your specific codebase.
• Live Updates: Re-run superdocs generate anytime to update your live docs.

Support

Visit superdocs.cloud for more information.