Skip to content

Releases: BinarCode/aidocs-cli

v0.13.0 - Config Rename & docs_root

22 Dec 17:01

Choose a tag to compare

Breaking Changes

  • Config file renamed: docs/config.ymldocs/aidocs-config.yml
  • Config is now required - workflows will prompt for /docs:init if not found

New Features

  • docs_root config key: Specify where documentation output goes

    docs_root: docs  # or any custom path
  • Step 0 Config Discovery: All workflows now search for config in:

    1. docs/aidocs-config.yml (default)
    2. ./aidocs-config.yml (project root)
  • Migration hints: If old config.yml found, shows message to rename it

Updated Workflows

  • /docs:init - Creates aidocs-config.yml with docs_root key
  • /docs:generate - Uses {docs_root} for all output paths
  • /docs:flow - Uses {docs_root} for flow documentation
  • /docs:batch - Uses {docs_root} for batch output
  • /docs:update - Uses {docs_root} for doc updates
  • /docs:execute - Uses {docs_root} for plan execution

Migration Guide

  1. Rename your config file:

    mv docs/config.yml docs/aidocs-config.yml
  2. Add docs_root to your config (optional, defaults to docs):

    docs_root: docs

v0.12.1

22 Dec 15:59

Choose a tag to compare

Fixes

  • --force now overwrites files without deleting folders (preserves custom files)
  • /docs:generate outputs to docs/{module}/ folder structure

Install/Upgrade

uv tool install aidocs --upgrade

v0.12.0

22 Dec 15:33

Choose a tag to compare

New Feature: aidocs export-pdf

Export markdown documentation to PDF directly from the CLI - no Claude Code needed!

aidocs export-pdf docs/projects/index.md
aidocs export-pdf docs/flows/sync-users.md -o manual.pdf

Features

  • Pure Python CLI command (no token limits!)
  • Auto-generates table of contents from H1/H2 headings
  • Uses Chrome/Chromium headless for high-quality PDF rendering
  • Styled code blocks, tables, and images
  • Page breaks at H1 headings

Requirements

  • Chrome or Chromium installed

Install/Upgrade

uv tool install aidocs --upgrade

v0.11.1

22 Dec 15:11

Choose a tag to compare

Fixes

  • /docs:generate now outputs to docs/{module}/ folder structure
    • /docs:generate projectsdocs/projects/index.md
    • /docs:generate /users/settingsdocs/users-settings/index.md
    • Images saved to docs/{module}/images/
    • Consistent with /docs:flow output structure

Install/Upgrade

uv tool install aidocs --upgrade

v0.11.0

22 Dec 15:05

Choose a tag to compare

What's New

/docs:export-pdf Command

Export markdown documentation to PDF with auto-generated table of contents using Playwright MCP.

/docs:export-pdf docs/pages/dashboard.md
/docs:export-pdf docs/flows/sync-users.md --output manual.pdf

Features:

  • Auto-generated TOC from H1/H2 headings with clickable links
  • PDF-friendly styling (page breaks at H1, code block formatting)
  • Embedded images (converted to base64)
  • A4 format with proper margins

Output: docs/exports/{filename}.pdf

Install/Upgrade

uv tool install aidocs --upgrade
# or
pipx upgrade aidocs

v0.7.1

20 Dec 11:05

Choose a tag to compare

What's New in v0.7.1

Improvements

  • /docs:init now suggests the recommended workflow after setup:
    1. Review docs-config.yaml and adjust if needed
    2. /docs:discover - Scan codebase, find all modules
    3. /docs:plan - Create documentation plan
    4. /docs:execute - Generate all documentation
    

Installation

# Install from GitHub
uv tool install aidocs-cli --from git+https://github.com/BinarCode/aidocs-cli.git

# Or update existing
aidocs update --github

Full Changelog: v0.7.0...v0.7.1

v0.7.0

20 Dec 10:58

Choose a tag to compare

What's New in v0.7.0

Changes

Reorganized File Structure

  • Workflows moved: docs-workflows/.claude/workflows/docs/
  • All Claude-related files now under .claude/:
    .claude/
    ├── commands/docs/     # Slash commands
    └── workflows/docs/    # Workflow implementations
    

New Update Option

  • aidocs update --github: Install latest from GitHub instead of PyPI
    aidocs update              # Update from PyPI
    aidocs update --github     # Update from GitHub (latest)

Installation

# Install from GitHub (recommended for latest)
uv tool install aidocs-cli --from git+https://github.com/BinarCode/aidocs-cli.git

# Or update existing installation
aidocs update --github

Full Changelog: v0.6.0...v0.7.0

v0.6.0

20 Dec 10:43

Choose a tag to compare

What's New in v0.6.0

Changes

  • Renamed knowledge base folder: .docs-knowledgedocs/.knowledge
    • All documentation artifacts now live under the docs/ directory
    • Better visibility and organization

New Structure

docs/
├── .knowledge/          # Knowledge base (was .docs-knowledge)
│   ├── _meta/
│   ├── modules/
│   └── relationships/
├── users/               # Generated docs
├── campaigns/
└── index.md

Full Changelog: v0.5.0...v0.6.0

v0.5.0

20 Dec 10:36

Choose a tag to compare

What's New in v0.5.0

New Commands

Batch Documentation Workflow

  • /docs:discover - Scan codebase, find all modules
  • /docs:plan - Create ordered documentation plan (docs-plan.yaml)
  • /docs:execute - Run through plan, generate all docs with screenshots

CLI Updates

  • aidocs update - Self-update command (auto-detects uv/pipx/pip)

Features

  • Priority-based module ordering (dependencies documented first)
  • Cross-module flow detection and documentation
  • Resume support (--continue flag) if execution is interrupted
  • Dry run mode (--dry flag) to preview what would be generated
  • Interactive planning or auto-generate (--auto flag)
  • Progress tracking with plan status updates

Usage

# Document entire project
/docs:discover                    # Find all modules
/docs:plan                        # Create plan
/docs:execute                     # Generate all docs

# Or document single module
/docs:flow campaign               # Full lifecycle docs

# Update CLI
aidocs update

Full Changelog: v0.4.0...v0.5.0