Simply CLI

A lightweight CLI to manage your AI coding assistant configurations and professional design documents.

Features

• Single source of truth for AI configs (.ai/ directory)
• Sync to Cursor, Claude, Gemini, GitHub Copilot, and Codex
• Modular command architecture — easy to extend and customize
• Beautiful, ready-to-use design document template
• Project-level sync support
• Built-in diagnostics (doctor command)

Installation

bash install.sh

After installation, make sure ~/.local/bin is in your PATH:

export PATH="$HOME/.local/bin:$PATH"

What the installer does:

• Copies commands/ directory to ~/.simply/commands/
• Creates the simply binary at ~/.local/bin/simply
• Sets up shell completion and PATH configuration

Quick Start

# Initialize AI configuration structure
simply init ai

# Create a professional design document
simply create design-doc

# Sync AI rules to all tools
simply sync ai

# Check status
simply doctor

Core Commands

Command	Purpose
simply init ai	Create .ai/ folder structure
simply create design-doc	Generate design-doc.md from template
simply sync ai	Sync .ai/ to all AI tools
simply sync ai --dry-run	Preview sync without making changes
simply status	Show .ai/ configuration status
simply doctor	Run full diagnostics
simply --version	Display version information
simply help	Show complete help

Architecture

Simply CLI uses a modular command architecture for easy maintenance and extensibility:

simply (binary)
  └─ Sources ~/.simply/commands/*.sh
      ├─ 00-utils.sh          (shared functions)
      ├─ 01-init.sh           (init command)
      ├─ 02-create.sh         (create command)
      ├─ 03-sync.sh           (sync command)
      ├─ 04-status.sh         (status command)
      ├─ 05-doctor.sh         (doctor command)
      ├─ 06-update.sh         (update command)
      ├─ 07-uninstall.sh      (uninstall command)
      ├─ 08-version.sh        (version command)
      └─ 09-help.sh           (help command)

Key Benefits:

• Each command is in its own file — easy to understand and modify
• Numeric prefixes (00-09) determine load order
• Add new commands by creating commands/10-mycommand.sh
• Utilities in 00-utils.sh available to all commands

Configuration

The .ai/ Directory

All AI configurations live in .ai/:

.ai/
├── AGENTS.md              # Root configuration & instructions
├── rules/                 # Project-specific rules
│   ├── 01-code-style.md
│   ├── 02-testing.md
│   └── 03-error-recovery.md
└── skills/                # Skills & capabilities
    ├── advanced.md
    └── basics.md

Run simply sync ai to sync all content to your AI tools.

Design Document

simply create design-doc creates a high-quality design document with:

• Clear Goals and Non-Goals
• Architecture & Design with Mermaid support
• Alternatives Considered comparison table
• Data Model, API Changes, Testing, etc.
• Approval checklist

Example usage:

simply create design-doc
# → Creates design-doc.md ready to be filled

Extending Simply CLI

Add a New Command

1. Create commands/10-mycommand.sh:

cmd_mycommand() {
  log "Doing something..."
  log "✅ Done"
}

2. Update case statement in install.sh
3. Update help in commands/09-help.sh
4. Reinstall: bash install.sh
5. Test: simply mycommand

See .ai/AGENTS.md for detailed documentation.

Documentation

• .ai/AGENTS.md — Complete project architecture and development guide
• REFACTORING.md — Details of the modular refactoring
• commands/README.md — Command development guide
• Makefile — Development shortcuts

Supported AI Tools

Tool	Config Location	Format
Cursor	.cursor/rules/main.mdc	MDC (Markdown)
Claude	.claude/CLAUDE.md	Markdown
GitHub Copilot	.github/copilot-instructions.md	Markdown
Gemini	.gemini/GEMINI.md	Markdown
Codex	.codex/instructions.md	Markdown

Troubleshooting

# Check installation status
simply doctor

# Preview changes before syncing
simply sync ai --dry-run

# Check current configuration
simply status

# View help
simply help

Development

# Check syntax
bash -n install.sh
bash -n commands/*.sh

# Run tests
make test

# Reinstall locally
bash install.sh

License

MIT — Feel free to use, modify, and extend!