AI Docs CLI

AI Docs CLI

AI Docs CLI is a powerful command-line interface tool crafted in Go that streamlines the management of AI-generated memory files, such as GEMINI.md, CLAUDE.md, and other related files. This tool allows users to easily manage their AI memory on a dedicated Git branch with an intuitive workflow designed for seamless file isolation and synchronization.

Key Features

• Isolated Memory Management: Automatically creates an orphan branch dedicated to AI memory files, ensuring a clean project structure.
• Git Worktree Integration: Sets up a Git worktree for efficient file management, allowing separate handling of AI documents.
• Automated .gitignore Updates: Automatically manages .gitignore to prevent unnecessary files in the repository.
• Flexible Workflow Commands: Provides distinct commands for pulling and pushing changes, enhancing user control over the workflow.
• Multi-Agent Support: Compatible with multiple AI agents, including Cline, Claude, Gemini, and Cursor.
• Flexible Configuration Options: Configuration can be easily handled via YAML, JSON, or TOML formats.

Usage Overview

Initialize AI Docs

To set up AI Docs, the following command initializes the configuration and prepares the dedicated Git branch:

ai-docs init [--config path/to/.ai-docs.config.yml] [--force] [--dry-run] [-v]

This command performs several key actions, such as creating an orphan branch, copying AI memory files, committing and pushing changes, and updating .gitignore. It ensures that the main branch remains uncluttered by AI-specific files.

Push Changes

To sync local AI documents to the dedicated branch, use the command:

ai-docs push [--config path/to/config.yml] [--dry-run] [-v]

This commits any local updates and pushes them to the remote repository, allowing for easy collaboration and backup of AI documents.

Pull Changes

To retrieve the latest updates from the AI docs branch, the command is:

ai-docs pull [--config path/to/config.yml] [--overwrite] [--dry-run] [-v]

This pulls the most recent changes, with an optional overwrite to replace existing local files.

Cleanup Operations

For cleaning up the worktree and branch once done, the following command is available:

ai-docs clean [--config path/to/config.yml] [--force] [--dry-run] [-v]

Configuration

Setting up a configuration file (.ai-docs.config.yml) in your project root allows customization of various parameters to suit specific workflows:

userName: ""   # fallback when git config user.name is empty
mainBranchName: "main"
docBranchNameTemplate: "@ai-docs/{userName}"
docWorktreeDir: ".ai-docs"
aIAgentMemoryContextPath:
  Cline: "memory-bank"
  Claude: "CLAUDE.md"
  Gemini: "GEMINI.md"
  Cursor: ".cursor/rules"
ignorePatterns:
  - "/memory-bank/"
  - "CLAUDE.md"
  - "GEMINI.md"
  - "/.cursor/rules"

Requirements

• Git 2.7.0 or higher (required for worktree support)
• Go version 1.24 or higher (needed for building from source)

AI Docs CLI is an essential tool for developers and data scientists looking to maintain organized and isolated AI memory files while leveraging Git's powerful version control capabilities.