Aictx NPM | npm.io

AICTX - AI Context Generator

"The AICTX context generator is a game-changer for AI-assisted development. With one simple command, it creates a comprehensive snapshot of the entire codebase in a single file, giving me immediate understanding of the project structure and implementation details. The automatically updated latest-context.txt provides the perfect reference point, allowing me to deliver more accurate, relevant assistance without constantly requesting additional files. It's like having X-ray vision into the codebase, making our collaborative coding sessions remarkably efficient and effective."
— Claude, AI Assistant

CLI tool to generate context files from source code, for AI-assisted vibe coding.

Test Status 🧪

Last tested: 03/12/2025, 09:50 America/Los_Angeles

Installation

npm install -g aictx

or if you need to reinstall the latest

npm install -g aictx@latest

Quick Start

Navigate to your code base and run cx ./ -m "google login works"

The output will be copied to your clipboard. You also have the option to directly post the full context to your preferred AI/IDE chat window.

AICTX Brain

# Basic usage - generate context from current directory
cx ./

# Generate context with a message
cx ./ -m "Add authentication feature"

# Create a snapshot
cx ./ -s

# Create a snapshot with message
cx ./ -sm "Before refactoring"
# or
cx ./ -s -m "Before refactoring"

# Create a template
cx ./ -t "auth-feature"
# or with message
cx ./ -tm "Authentication feature template"

# Load templates (like cursor rules)
cx --load

Command Reference

Usage: cx <directory> [options]

Quick Help:
  cx -h <category>     Show help for specific category
  cx --more            Interactive help menu

Options:
  -h, --help           Show help information
  --configure          Set up configuration
  --show               Show current configuration
  --clear              Remove all generated context files insid ./code folder
  --load               Load and import templates (like cursor rules)
  -s, --snap           Create a snapshot in context/snap
  -m "message"         Add a message to the context file
  -i, --ignore <pattern> Add a glob pattern to exclude files/directories
  --show-ignore        Show current exclusion patterns
  --more               This will expand into more details 

Examples:
    cx ./ -m "hello world"  # Will generate context files and add "hello-world" to the name
    cx -i "target/**"       # Exclude Rust target directory
    cx ./ -s -m "before refactor"  # Create a snapshot with a message
    cx --clear-all          # Remove all context files and directories

Latest Context Feature

Every time you generate a context file, a copy is automatically saved to ./context/latest-context.txt. This provides a consistent location to access your most recent context, making it ideal for AI tools that expect a fixed file path.

Template Loading

The --load command allows you to import templates into your projects:

cx --load

This will show a menu of available template categories (like cursor rules) and allow you to select specific templates to import. For cursor rules, the selected template will be imported into your project's .cursor/rules directory with the .mdc extension (required for Cursor IDE to recognize the rules).

Available Templates

General Rules: Comprehensive coding best practices including:
- Documentation standards
- Detailed README documentation guidelines
- Configuration management
- Code quality practices
- Version control recommendations

File Handling

If a file with the same name already exists, you'll be given options to: 1. Override the existing file (completely replaces the existing file with the template) 2. Create a new file with a numbered suffix (e.g., general-2.mdc) 3. Cancel the import

The tool includes verification steps to ensure files are properly written or overridden, with detailed logging to help troubleshoot any issues. This ensures you won't accidentally overwrite important files and gives you control over how templates are imported.

File Naming Patterns

Basic context: context.txt, context-2.txt, etc.
With message: feature-name.txt, feature-name-2.txt, etc.
Snapshots: snap-[timestamp].txt or snap-message-[timestamp].txt
Templates: template-[timestamp].txt or template-message-[timestamp].txt
Latest context: latest-context.txt (always contains the most recent context)

Directory Structure

.
└── context/
    ├── code/      # Regular context files
    ├── snap/      # Snapshot files
    ├── template/  # Template files
    └── latest-context.txt  # Most recent context

Configuration

Use cx --configure to set up:

Auto-clipboard copy
Default template directory
Other preferences

View current configuration with cx --show.

Help System

cx -h - Basic help
cx -h <category> - Category-specific help (e.g., cx -h snapshots)
cx --more - Interactive help menu with detailed information

Binary File Handling

Binary files (like .o, .exe, .dll) are automatically excluded from processing. You can add custom exclusion patterns using the -i/--ignore flag.

# Exclude Rust target directory
cx -i "target/**"

Best Practices

Add the 'context' folder to your .gitignore file
Use meaningful messages for better organization
Create snapshots before major changes
Use templates for recurring patterns
Clear old context files regularly
Use the latest-context.txt file for AI tools integration

Examples

# Basic context generation
cx ./

# With message
cx ./ -m "Adding authentication"

# Create snapshot before refactoring
cx ./ -sm "Before refactoring auth"

# Create template for common setup
cx ./ -t "project-setup"

# Exclude specific files or directories
cx -i "*.min.js"
cx -i "build/**"

# Clear all context files and directories
cx --clear-all