@relipa/ai-flow-kit 0.0.1

package/docs/cli-reference.md

@@ -0,0 +1,438 @@
+# CLI Reference
+
+Complete reference for all `aiflow` commands.
+
+## Commands Overview
+
+```bash
+aiflow --help                    # Show all commands
+aiflow <command> --help          # Show command help
+```
+
+## init
+
+Initialize AI Flow Kit in your project.
+
+```bash
+# Basic initialization
+aiflow init
+
+# With framework
+aiflow init --framework laravel
+
+# With adapter (MCP integration)
+aiflow init --adapter jira
+
+# Full setup
+aiflow init --framework laravel --adapter jira
+```
+
+**Options:**
+- `-f, --framework <type>` — Framework template (laravel, nextjs, vue-nuxt)
+- `-a, --adapter <type>` — MCP adapter (jira, backlog, google-sheets)
+
+**What it does:**
+1. Creates `.claude/skills/` with all available skills
+2. Creates `.rules/` with team rules
+3. Creates `.aiflow/` with version tracking
+4. Optionally sets up framework template (CLAUDE.md)
+5. Optionally configures MCP adapter
+
+**Example:**
+```bash
+$ aiflow init --framework laravel --adapter jira
+Initializing ai-flow-kit (v1.0.0)...
+✓ Copied skills to .claude/skills
+✓ Copied rules to .rules
+✓ Set up CLAUDE.md for framework: laravel
+✓ Updated MCP configuration for jira
+
+✨ Initialized AI Flow Kit successfully!
+```
+
+## use
+
+Load context from a ticket, file, or manual entry.
+
+```bash
+# Load from Jira ticket
+aiflow use JIRA-2024-123
+
+# Load from Backlog
+aiflow use BACKLOG-456
+
+# Manual entry
+aiflow use --manual
+
+# Load from local file
+aiflow use --file path/to/context.json
+
+# Switch between versions
+aiflow use 1.0.0
+```
+
+**Options:**
+- `<id>` — Ticket ID or version number
+- `-m, --manual` — Manual context entry
+- `-f, --file <path>` — Load from JSON file
+- `-s, --save <name>` — Save as named context
+
+**What it does:**
+1. Fetches context from MCP adapter (if applicable)
+2. Parses and validates context
+3. Saves to `.claude/context/current.json`
+4. Updates state tracking
+
+**Example:**
+```bash
+$ aiflow use JIRA-123
+Fetching context from Jira...
+✓ Title: Fix payment processing error
+✓ Description: 2000+ words pulled
+✓ Acceptance criteria: 3 items
+✓ Saved to .claude/context/current.json
+
+Ready to prompt! Run: aiflow prompt bug-fix
+```
+
+## prompt
+
+Generate an AI prompt with context, rules, and template.
+
+```bash
+# Generate bug fix prompt
+aiflow prompt bug-fix
+
+# Generate feature prompt
+aiflow prompt feature
+
+# Generate investigation prompt
+aiflow prompt investigation
+
+# Generate refactor prompt
+aiflow prompt refactor
+
+# Generate impact analysis prompt
+aiflow prompt impact
+
+# List available prompts
+aiflow prompt --list
+```
+
+**Options:**
+- `<type>` — Prompt type (bug-fix, feature, investigation, refactor, impact, docs)
+- `-l, --list` — List available prompt types
+- `-o, --output <file>` — Save to file instead of printing
+- `-c, --copy` — Copy to clipboard
+- `--lang <lang>` — Language (english, vietnamese)
+- `--detail <level>` — Detail level (minimal, standard, comprehensive)
+
+**What it does:**
+1. Loads current context (from `aiflow use`)
+2. Loads prompt template for the type
+3. Loads framework rules
+4. Loads team rules and best practices
+5. Merges everything into a complete prompt
+6. Prints to console (or saves/copies)
+
+**Example:**
+```bash
+$ aiflow prompt bug-fix
+═══════════════════════════════════════════════════════════════
+BUG FIX INVESTIGATION PROMPT
+═══════════════════════════════════════════════════════════════
+
+## Context
+Title: Payment processing fails on checkout
+Description: Users report seeing payment error when... [2000+ words]
+
+## Framework Rules (Laravel)
+- Use Laravel's built-in tools...
+- Keep Controllers thin...
+
+## Team Rules
+- Use strict typing...
+- Follow PSR-12 styling...
+
+## Task
+Investigate the bug following this process:
+1. Understand the error context...
+[Complete prompt ready to copy to Claude]
+```
+
+## detect
+
+Auto-detect task type from a description.
+
+```bash
+# Detect from description
+aiflow detect "Payment integration is broken"
+
+# Detect from current context
+aiflow detect
+
+# Show confidence
+aiflow detect "Add new feature" --verbose
+```
+
+**Options:**
+- `<description>` — Description to analyze
+- `-v, --verbose` — Show detection reasoning
+- `-t, --threshold <number>` — Confidence threshold (0-100)
+
+**What it does:**
+1. Analyzes description for keywords
+2. Classifies as bug-fix, feature, refactor, investigation, etc
+3. Shows confidence score
+4. Suggests appropriate skill
+
+**Example:**
+```bash
+$ aiflow detect "Users can't save their orders"
+🐛 Bug Fix (98% confidence)
+
+Detected keywords:
+- "can't save" → bug pattern
+- Specific area → likely regression
+
+Suggested skill: investigate-bug
+
+Next: aiflow prompt bug-fix
+```
+
+## context
+
+Manage task contexts (save, load, list, delete).
+
+```bash
+# List saved contexts
+aiflow context --list
+
+# Save current context with name
+aiflow context --save "checkout-fix"
+
+# Load saved context
+aiflow context --load "checkout-fix"
+
+# Delete saved context
+aiflow context --delete "checkout-fix"
+
+# Clear all contexts
+aiflow context --clear
+
+# Show current context
+aiflow context --show
+```
+
+**Options:**
+- `-l, --list` — List all saved contexts
+- `-s, --save <name>` — Save current context
+- `--load <name>` — Load saved context
+- `-d, --delete <name>` — Delete saved context
+- `--clear` — Clear all contexts
+- `--show` — Show current context details
+
+**What it does:**
+1. Lists, saves, loads, or deletes contexts
+2. Manages context history in `.claude/context/history/`
+3. Makes it easy to switch between tasks
+
+**Example:**
+```bash
+$ aiflow context --list
+Saved contexts:
+  1. checkout-fix (saved 2 hours ago)
+  2. payment-integration (saved yesterday)
+  3. user-auth-bug (saved 3 days ago)
+
+$ aiflow context --load checkout-fix
+✓ Loaded: checkout-fix
+✓ Ready to prompt!
+```
+
+## update
+
+Update to the latest version.
+
+```bash
+# Update to latest
+aiflow update
+
+# Keep old version
+aiflow update --keep-old
+```
+
+**Options:**
+- `--keep-old` — Don't delete previous version
+- `--force` — Force update even if already latest
+
+**What it does:**
+1. Checks for newer version
+2. Downloads assets (skills, rules, templates)
+3. Updates `.claude/` and `.rules/`
+4. Optionally deletes old version
+5. Updates state tracking
+
+**Example:**
+```bash
+$ aiflow update
+Updating from v1.0.0 to v1.1.0...
+✓ Downloaded skills for v1.1.0
+✓ Downloaded rules for v1.1.0
+
+Keep old version (v1.0.0)? (y/n) y
+✓ Kept v1.0.0
+
+You can switch back with: aiflow use 1.0.0
+
+✨ Update completed!
+```
+
+## doctor
+
+Health check for your setup.
+
+```bash
+# Run health check
+aiflow doctor
+
+# Fix issues automatically
+aiflow doctor --fix
+```
+
+**Options:**
+- `--fix` — Attempt to fix found issues
+- `-v, --verbose` — Show detailed checks
+
+**What it does:**
+1. Checks for required directories
+2. Validates configuration files
+3. Checks MCP adapter setup
+4. Verifies framework template
+5. Reports issues and fixes
+
+**Example:**
+```bash
+$ aiflow doctor
+Running health check for AI Flow Kit...
+
+✓ .claude/skills exists
+✓ .rules exists
+✓ CLAUDE.md exists
+✓ Version tracking active (v1.0.0)
+✓ Jira adapter configured
+✓ Laravel framework template loaded
+
+✨ Everything looks healthy! You are ready to fly.
+```
+
+## validate
+
+Validate AI output against team rules and quality standards.
+
+```bash
+# Validate a file
+aiflow validate output.php
+
+# Validate with specific rule set
+aiflow validate output.php --ruleset strict
+
+# Show detailed report
+aiflow validate output.php --verbose
+```
+
+**Options:**
+- `<file>` — File to validate
+- `-r, --ruleset <set>` — Rule set (default, strict, custom)
+- `-v, --verbose` — Detailed report
+- `--fix` — Attempt to fix issues
+
+**What it does:**
+1. Loads validation rules from `custom/rules/`
+2. Checks code style, naming, security, etc
+3. Reports violations
+4. Optionally suggests fixes
+
+**Example:**
+```bash
+$ aiflow validate src/Payment.php
+Validating against ruleset: default
+
+✓ Code style: OK
+⚠ Naming: Variable $p should be $payment
+✓ Security: OK
+✗ Testing: Missing test file
+
+Issues found: 2 warnings, 1 error
+Suggestions: Add test case, rename variable
+```
+
+## memory
+
+Manage team knowledge and context memory.
+
+```bash
+# Save knowledge
+aiflow memory --save "Laravel validation pattern" "Use FormRequest..."
+
+# Retrieve knowledge
+aiflow memory --get "Laravel validation pattern"
+
+# List all memories
+aiflow memory --list
+
+# Delete memory
+aiflow memory --delete "old-memory"
+
+# Search memories
+aiflow memory --search "validation"
+```
+
+**Options:**
+- `-s, --save <key> <value>` — Save memory
+- `-g, --get <key>` — Retrieve memory
+- `-l, --list` — List all memories
+- `-d, --delete <key>` — Delete memory
+- `--search <query>` — Search memories
+- `--auto-load` — Auto-load relevant memories
+
+**What it does:**
+1. Stores team knowledge in `.aiflow/memory/`
+2. Auto-loads relevant memory for current task
+3. Makes knowledge discoverable across team
+
+**Example:**
+```bash
+$ aiflow memory --save "payment-flow" "Process: 1. Validate amount, 2. Call Stripe API, 3. Update DB"
+✓ Saved: payment-flow
+
+$ aiflow memory --search "payment"
+Found 3 memories matching "payment":
+  1. payment-flow
+  2. payment-error-handling
+  3. payment-tests
+```
+
+## Global Options
+
+These work with any command:
+
+```bash
+aiflow <command> --version       # Show version
+aiflow <command> --verbose       # Verbose output
+aiflow <command> --debug         # Debug mode
+aiflow <command> --config <file> # Use custom config file
+```
+
+## Exit Codes
+
+- `0` — Success
+- `1` — General error
+- `2` — Command not found
+- `3` — Invalid arguments
+- `4` — Configuration error
+- `5` — MCP adapter error
+
+---
+
+See [Getting Started](./getting-started.md) for tutorials and [Configuration](./configuration.md) for detailed options.