core/cli
8
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions 1
cli/docs/cmd/index.md
Clotho 36f790ed22 docs: add comprehensive CLI documentation for issue #4 
Added comprehensive documentation for core/cli including:

1. Complete CLI Reference (cli-reference.md)
   - All 30 commands with detailed descriptions
   - Subcommands, flags, and usage examples
   - Organized by category (Development, AI/ML, DevOps, etc.)

2. Build Variants System (build-variants.md)
   - How to create custom builds (minimal, dev, devops, ai/ml)
   - Three methods: import commenting, multiple main.go, build tags
   - External variant repos (core/php, core/ci)
   - Size optimization and compression tips

3. MCP Integration (mcp-integration.md)
   - Model Context Protocol server setup
   - All available tools (file ops, RAG, metrics, process mgmt, WebView/CDP)
   - Transport modes (stdio, TCP)
   - Security considerations and workspace restriction
   - Use cases and troubleshooting

4. Environment Variables (environment-variables.md)
   - All supported environment variables
   - Configuration file locations (user, project, registry)
   - CORE_CONFIG_* mapping system
   - Service-specific vars (MCP, RAG, ML, Git, etc.)
   - Best practices and troubleshooting

5. Updated Navigation
   - Enhanced cmd/index.md with categories and quick links
   - Updated mkdocs.yml with new documentation pages

Fixes #4

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-02-16 17:16:48 +00:00

3.3 KiB
Raw Blame History

Core CLI

Unified interface for development, multi-repo management, deployment, AI/ML operations, and infrastructure management.

Quick Links

Command Categories

Development & Testing

Command Description
dev Multi-repo workflow + dev environment
go Go development tools
test Run Go tests with coverage
qa Quality assurance workflow
doctor Check environment

AI & Machine Learning

Command Description
ai AI agent task management and Claude integration
AI ml ML inference and training pipeline
AI mcp Model Context Protocol server
AI rag RAG system for semantic search
AI collect Data collection from external sources

Infrastructure & Deployment

Command Description
AI deploy Coolify deployment management
AI prod Production infrastructure management
vm LinuxKit VM management
AI unifi UniFi network management
AI monitor Security monitoring

Git & Forge

Command Description
AI git Root-level git workflow
AI forge Forgejo instance management
AI gitea Gitea instance management

Configuration & Utilities

Command Description
AI config Configuration management
AI crypt Cryptographic utilities
docs Documentation management
AI help Help documentation
AI plugin Plugin management
AI workspace Workspace configuration

Services

Command Description
AI daemon Background service management
AI session Session recording and replay
AI lab Homelab monitoring dashboard

Installation

go install forge.lthn.ai/core/cli/cmd/core@latest

Verify: core doctor

See Getting Started for all installation options.

Build Variants

The Core CLI supports modular builds. You can create specialized variants:

  • Full - All commands (default)
  • Minimal - Essential commands only
  • Developer - Development-focused
  • DevOps - Infrastructure and deployment
  • AI/ML - AI and machine learning operations

See Build Variants for details.

Quick Start

# Check environment
core doctor

# Multi-repo workflow
core dev work

# Start MCP server for AI assistants
core mcp serve --workspace /path/to/project

# Run tests
core test

# Get help
core help
core <command> --help

Documentation