Statamic Context CLI

Overview

Statamic Context CLI is a Laravel package designed to bridge the gap between AI coding assistants and Statamic documentation. It provides searchable, AI-friendly access to both Statamic core documentation and Peak starter kit documentation through simple Artisan commands.

Features

• Search and retrieve Statamic documentation directly from the command line

• Access Peak starter kit documentation with dedicated commands

• Interactive search mode for exploring documentation

• Automatic documentation updates from GitHub repositories

• AI-optimized output format for better context understanding

• Lightweight SQLite storage for fast searches

Why This Package?

When working with AI coding assistants like Claude, GitHub Copilot, or ChatGPT, providing accurate documentation context is crucial for getting helpful responses. This package makes it easy to feed relevant Statamic and Peak documentation to your AI assistant, ensuring you get accurate, up-to-date information about Statamic's features and best practices.

Installation

Install the package via Composer:

composer require kauffinger/statamic-context-cli

Then publish the configuration file:

php artisan vendor:publish --tag="statamic-context-config"

Usage Examples

Search for Statamic documentation:

# Search for collections documentation
php artisan statamic-context:docs:search collections

# Interactive search mode
php artisan statamic-context:docs:search --interactive

# Get specific documentation entry
php artisan statamic-context:docs:get core:collections

Search for Peak documentation:

# Search for page builder documentation
php artisan statamic-context:peak:search page-builder

# Get specific Peak documentation
php artisan statamic-context:peak:get features:page-builder

Update documentation from GitHub:

# Update Statamic documentation
php artisan statamic-context:docs:update

# Update Peak documentation
php artisan statamic-context:peak:update

Tech Stack

• Laravel - PHP framework integration

• Statamic - The flat-first CMS that we're documenting

• SQLite - Lightweight database for storing documentation

• GitHub API - For fetching latest documentation updates

Contributing

Contributions are welcome! Feel free to submit issues or pull requests on GitHub to help improve the package.