@relipa/ai-flow-kit 0.0.7 → 0.0.8-beta.0

package/docs/common/cli-reference.md

@@ -1,34 +1,56 @@
 # CLI Reference
 
-Complete reference for all `aiflow` commands.
+Complete reference for all `ak` / `aiflow` commands.
+
+> **Short alias:** `ak` is the preferred short form of `aiflow`. Every command also has a short alias shown in the format `command|alias`.
 
 ## Commands Overview
 
 ```bash
-aiflow --help                    # Show all commands
-aiflow <command> --help          # Show command help
+ak --help                        # Show all commands
+ak <command> --help              # Show command help
+ak <alias> --help                # Also works with aliases
 ```
 
+### Quick Alias Reference
+
+| Full command | Short | Full command | Short |
+|---|---|---|---|
+| `ak init` | `ak i` | `ak use` | `ak u` |
+| `ak prompt` | `ak p` | `ak detect` | `ak d` |
+| `ak task` | `ak t` | `ak context` | `ak ctx` |
+| `ak checkpoint` | `ak cp` | `ak validate` | `ak vl` |
+| `ak memory` | `ak mem` | `ak guide` | `ak g` |
+| `ak remove` | `ak rm` | `ak update` | `ak up` |
+| `ak sync-skills` | `ak sync` | `ak doctor` | `ak dr` |
+| `ak telemetry` | `ak tel` | | |
+
+| `task` sub-command | Short | `memory` sub-command | Short |
+|---|---|---|---|
+| `ak t status` | `ak t st` | `ak mem save` | `ak mem s` |
+| `ak t list` | `ak t ls` | `ak mem get` | `ak mem g` |
+| `ak t pause` | `ak t p` | `ak mem list` | `ak mem ls` |
+| `ak t switch` | `ak t sw` | `ak mem search` | `ak mem sr` |
+| `ak t resume` | `ak t r` | `ak mem delete` | `ak mem d` |
+| `ak t reset` | `ak t rst` | `ak mem clear` | `ak mem cl` |
+| `ak t remove` | `ak t rm` | | |
+| `ak t next` | `ak t n` | | |
+
 ## 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
+ak init                                      # basic initialization
+ak init -f laravel                           # with framework  (--framework)
+ak init -a jira                              # with adapter  (--adapter)
+ak init -f laravel -a jira                   # full setup
+ak init -f spring-boot --with-rtk            # enable RTK compression
+ak init --no-rtk                             # skip RTK setup
 ```
 
 **Options:**
-- `-f, --framework <types>` — Framework templates, comma-separated (e.g. `spring-boot,reactjs`)
+- `-f, --framework <types>` (alias: `--fw`) — Framework templates, comma-separated (e.g. `spring-boot,reactjs`)
 - `-a, --adapter <types>` — MCP adapters (jira, backlog, google-sheets)
 - `-e, --env <types>` — AI tools to configure (cursor, gemini, copilot, generic). Default excludes `generic`.
 - `--with-rtk` — Force enable RTK token compression hook
@@ -62,38 +84,31 @@ Initializing ai-flow-kit (v1.0.0)...
 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
-
-# Fast mode — lite Gate 1 (< 5 min, no Q&A)
-aiflow use BACKLOG-456 --fast
-
-# Full mode — force complete analysis
-aiflow use BACKLOG-456 --full
-
-# Manual entry
-aiflow use --manual
-
-# Load from local file
-aiflow use --file path/to/context.json
-
-# Switch between versions
-aiflow use 1.0.0
+ak use JIRA-123                              # load from Jira
+ak use BACKLOG-456                           # load from Backlog
+ak use BACKLOG-456 -F                        # fast mode  (--fast)
+ak use BACKLOG-456 -U                        # full mode  (--full)
+ak use -m                                    # manual entry  (--manual)
+ak use -f path/to/context.json               # load from file  (--file)
+ak use BACKLOG-456 -c                        # load with all comments  (--coms)
+ak use BACKLOG-456 --clast 5                 # last 5 comments
+ak use BACKLOG-456 --cid 42                  # specific comment
+ak use 1.0.0                                 # switch between versions
 ```
 
 **Options:**
 - `<id>` — Ticket ID or version number
 - `-m, --manual` — Manual context entry
-- `-f, --file <path>` — Load from JSON file
+- `-f, --file <path>` — Load from file (JSON or plain text)
 - `-s, --save <name>` — Save as named context
+- `-c, --coms` — Load all comments (alias for `--with-comments`)
 - `--with-comments` — Include all ticket comments
-- `--comments-last <n>` — Only fetch last N comments
-- `--comments-from <n>` — Fetch comments starting from comment N
-- `--fast` — Fast mode: AI skips Q&A, outputs lite 3-section requirement doc (< 5 min Gate 1). Best for clear tickets with ≥ 3 measurable AC.
-- `--full` — Full mode: force complete Gate 1 analysis with Q&A regardless of ticket clarity.
+- `--cid <id>` — Load a specific comment by ID
+- `--clast <n>` — Only fetch last N comments
+- `--cfrom <id>` — Fetch comments from ID N onward
+- `--cto <id>` — Fetch comments up to ID N
+- `-F, --fast` — Fast mode: AI skips Q&A, lite 3-section requirement doc (< 5 min Gate 1)
+- `-U, --full` — Full mode: force complete Gate 1 analysis with Q&A
 
 **What it does:**
 1. Fetches context from MCP adapter (if applicable)
@@ -113,42 +128,32 @@ Fetching context from Jira...
 Ready to prompt! Run: aiflow prompt bug-fix
 ```
 
-## task
+## task (alias: `t`)
 
 Manage multiple tasks — pause, switch, and resume while preserving gate progress.
 
 ```bash
-# Show active task + pending list
-aiflow task status
-
-# List all saved tasks
-aiflow task list
-
-# Pause current task (saves context + gate progress)
-aiflow task pause
-aiflow task pause --note "waiting for API spec from PM"
-
-# Pause current + switch to another task
-aiflow task switch PROJ-99
-
-# Resume a paused task
-aiflow task resume PROJ-33
-
-# Reset task to Gate 1 (keeps ticket context, clears gate progress)
-aiflow task reset PROJ-33
-
-# Permanently delete all saved data for a task
-aiflow task remove PROJ-33
+ak t st                                      # show active + pending  (task status)
+ak t ls                                      # list all saved tasks  (task list)
+ak t p                                       # pause current task  (task pause)
+ak t p -n "waiting for API spec from PM"     # pause with note  (--note)
+ak t sw PROJ-99                              # switch to another task  (task switch)
+ak t r PROJ-33                               # resume a paused task  (task resume)
+ak t rst PROJ-33                             # reset to Gate 1  (task reset)
+ak t rm PROJ-33                              # delete all task data  (task remove)
+ak t n                                       # approve gate & prep next session  (task next)
+ak t n -t PROJ-33                            # specify ticket  (--ticket)
 ```
 
-**Sub-commands:**
-- `status` — Show active task and all pending tasks
-- `list` — List all saved tasks with gate state
-- `pause [--note <text>]` — Save current progress and clear active task
-- `switch <ticket-id>` — Pause current task + load/switch to another
-- `resume <ticket-id>` — Restore a paused task as active
-- `reset <ticket-id>` — Reset gate progress to Gate 1 (keeps ticket context); prompts to optionally delete `plan/<id>/` files
-- `remove <ticket-id>` — Permanently delete all saved data for the task (state, context snapshot, plan files)
+**Sub-commands (with aliases):**
+- `status|st` — Show active task and all pending tasks
+- `list|ls` — List all saved tasks with gate state
+- `pause|p [-n <text>]` — Save current progress and clear active task
+- `switch|sw <ticket-id>` — Pause current task + load/switch to another
+- `resume|r <ticket-id>` — Restore a paused task as active
+- `reset|rst <ticket-id>` — Reset gate progress to Gate 1; prompts to optionally delete `plan/<id>/` files
+- `remove|rm <ticket-id>` — Permanently delete all saved data for the task
+- `next|n [-t <id>]` — Approve current gate and prepare next session
 
 **What it does:**
 1. Saves a snapshot of the current context (`current.json`) to `.aiflow/tasks/<taskId>/context.json`
@@ -208,36 +213,28 @@ aiflow task remove PROJ-33
 
 ---
 
-## prompt
+## prompt (alias: `p`)
 
 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
+ak p bug-fix                                 # generate bug fix prompt
+ak p feature                                 # generate feature prompt
+ak p investigation                           # generate investigation prompt
+ak p refactor                                # generate refactor prompt
+ak p impact                                  # generate impact analysis prompt
+ak p -l                                      # list all prompt types  (--list)
+ak p bug-fix -o p.md                         # save to file  (--output)
+ak p bug-fix -L vietnamese                   # Vietnamese language  (--lang)
+ak p bug-fix -d comprehensive                # comprehensive detail  (--detail)
 ```
 
 **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
-- `--lang <lang>` — Language (english, vietnamese)
-- `--detail <level>` — Detail level (minimal, standard, comprehensive)
+- `-L, --lang <lang>` — Language (english, vietnamese)
+- `-d, --detail <level>` — Detail level (minimal, standard, comprehensive)
 
 **What it does:**
 1. Loads current context (from `aiflow use`)
@@ -272,19 +269,15 @@ Investigate the bug following this process:
 [Complete prompt ready to copy to Claude]
 ```
 
-## detect
+## detect (alias: `d`)
 
 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
+ak d "Payment integration is broken"         # detect from description
+ak d                                         # detect from current context
+ak d "Add new feature" -v                    # show confidence  (--verbose)
+ak d "description" -t 90                     # set threshold  (--threshold)
 ```
 
 **Options:**
@@ -312,34 +305,22 @@ Suggested skill: investigate-bug
 Next: aiflow prompt bug-fix
 ```
 
-## context
+## context (alias: `ctx`)
 
 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
+ak ctx list                                  # list saved contexts
+ak ctx -s "checkout-fix"                     # save current context  (--save)
+ak ctx -l "checkout-fix"                     # load saved context  (--load)
+ak ctx -d "checkout-fix"                     # delete saved context  (--delete)
+ak ctx clear                                 # clear all contexts
+ak ctx show                                  # show current context
 ```
 
 **Options:**
-- `-l, --list` — List all saved contexts
 - `-s, --save <name>` — Save current context
-- `--load <name>` — Load saved context
+- `-l, --load <name>` — Load saved context
 - `-d, --delete <name>` — Delete saved context
 - `--clear` — Clear all contexts
 - `--show` — Show current context details
@@ -362,20 +343,17 @@ $ aiflow context --load checkout-fix
 ✓ Ready to prompt!
 ```
 
-## update
+## update (alias: `up`)
 
 Update to the latest version.
 
 ```bash
-# Update to latest
-aiflow update
-
-# Force update even if already latest
-aiflow update --force
+ak up                                        # update to latest
+ak up -f                                     # force update  (--force)
 ```
 
 **Options:**
-- `--force` — Force update even if already latest
+- `-f, --force` — Force update even if already latest
 
 **What it does:**
 1. Checks for newer version
@@ -399,13 +377,12 @@ You can switch back with: aiflow use 1.0.0
 ✨ Update completed!
 ```
 
-## sync-skills
+## sync-skills (alias: `sync`)
 
 Manually synchronize AI Instruction files with local custom skills.
 
 ```bash
-# Sync AI Instruction files
-aiflow sync-skills
+ak sync                                      # sync AI Instruction files
 ```
 
 **What it does:**
@@ -422,19 +399,18 @@ $ aiflow sync-skills
 ✨ Sync completed!
 ```
 
-## doctor
+## doctor (alias: `dr`)
 
 Health check for your setup.
 
 ```bash
-# Run health check
-aiflow doctor
-
-# Run with verbose output
-aiflow doctor --verbose
+ak dr                                        # run health check
+ak dr -v                                     # verbose output  (--verbose)
+ak dr -t PROJ-33                             # token breakdown for ticket  (--ticket)
 ```
 
 **Options:**
+- `-t, --ticket <id>` — Show token breakdown for specific ticket
 - `-v, --verbose` — Show detailed checks
 
 **What it does:**
@@ -459,26 +435,22 @@ Running health check for AI Flow Kit...
 ✨ Everything looks healthy! You are ready to fly.
 ```
 
-## validate
+## validate (alias: `vl`)
 
 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
+ak vl output.php                             # validate a file
+ak vl output.php -r strict                   # strict rule set  (--ruleset)
+ak vl output.php -v                          # detailed report  (--verbose)
+ak vl output.php -x                          # auto-fix trailing whitespace  (--fix)
 ```
 
 **Options:**
 - `<file>` — File to validate
-- `-r, --ruleset <set>` — Rule set (default, strict, custom)
+- `-r, --ruleset <set>` — Rule set (default, strict, lenient)
 - `-v, --verbose` — Detailed report
-- `--fix` — Attempt to fix issues
+- `-x, --fix` — Auto-fix trailing whitespace
 
 **What it does:**
 1. Loads validation rules from `custom/rules/`
@@ -500,22 +472,15 @@ Issues found: 2 warnings, 1 error
 Suggestions: Add test case, rename variable
 ```
 
-## telemetry
+## telemetry (alias: `tel`)
 
 Manage usage telemetry.
 
 ```bash
-# View current status, buffer size, last flush
-aiflow telemetry status
-
-# Interactive setup (URL, secret, email)
-aiflow telemetry enable
-
-# Disable tracking (config retained)
-aiflow telemetry disable
-
-# Force-send buffered events now
-aiflow telemetry flush
+ak tel status                                # view status, buffer size, last flush
+ak tel enable                                # interactive setup (URL, secret, email)
+ak tel disable                               # disable tracking (config retained)
+ak tel flush                                 # force-send buffered events now
 ```
 
 **Sub-commands:**
@@ -526,37 +491,26 @@ aiflow telemetry flush
 
 ---
 
-## memory
+## memory (alias: `mem`)
 
 Manage team knowledge and context memory.
 
 ```bash
-# Save knowledge
-aiflow memory save "payment-flow" "Process: 1. Validate amount, 2. Call Stripe API, 3. Update DB"
-
-# Retrieve knowledge
-aiflow memory get "payment-flow"
-
-# List all memories
-aiflow memory list
-
-# Delete memory
-aiflow memory delete "old-memory"
-
-# Search memories
-aiflow memory search "validation"
-
-# Clear all memories
-aiflow memory clear
+ak mem s "payment-flow" "Process: 1. Validate, 2. Call Stripe, 3. Update DB"   # save
+ak mem g "payment-flow"                      # retrieve  (memory get)
+ak mem ls                                    # list all  (memory list)
+ak mem sr "validation"                       # search  (memory search)
+ak mem d "old-memory"                        # delete  (memory delete)
+ak mem cl                                    # clear all  (memory clear)
 ```
 
-**Sub-commands:**
-- `save <key> <value>` — Save a note
-- `get <key>` — Read a note
-- `list` — List all notes
-- `search <query>` — Search notes
-- `delete <key>` — Delete a note
-- `clear` — Clear all notes
+**Sub-commands (with aliases):**
+- `save|s <key> <value>` — Save a note
+- `get|g <key>` — Read a note
+- `list|ls` — List all notes
+- `search|sr <query>` — Search notes
+- `delete|d <key>` — Delete a note
+- `clear|cl` — Clear all notes
 
 **What it does:**
 1. Stores team knowledge in `.aiflow/memory/`
@@ -574,24 +528,19 @@ Found 3 memories matching "payment":
   3. payment-tests
 ```
 
-## guide
+## guide (alias: `g`)
 
 Show quickstart guide.
 
 ```bash
-# Full guide
-aiflow guide
-
-# Architecture & flow only
-aiflow guide --flow
-
-# Command reference only
-aiflow guide --commands
+ak g                                         # full guide
+ak g -f                                      # architecture & flow only  (--flow)
+ak g -c                                      # command reference only  (--commands)
 ```
 
 **Options:**
-- `--flow` — Show architecture & flow diagram only
-- `--commands` — Show command reference only
+- `-f, --flow` — Show architecture & flow diagram only
+- `-c, --commands` — Show command reference only
 
 ---
 
@@ -617,13 +566,29 @@ aiflow gate <n> approved --ticket <id>
 
 ---
 
+## remove (alias: `rm`)
+
+Remove ai-flow-kit from project, a cached version, or uninstall globally.
+
+```bash
+ak rm                                        # remove from project
+ak rm -g                                     # uninstall globally  (--global)
+ak rm --version 1.0.0                        # remove cached version from .aiflow/
+```
+
+**Options:**
+- `--version <ver>` — Remove a specific cached version from `.aiflow/versions/`
+- `-g, --global` — Uninstall the global npm package (removes `aiflow` command)
+
+---
+
 ## Global Options
 
 These work with any command:
 
 ```bash
-aiflow --version                 # Show installed version
-aiflow <command> --help          # Show help for a command
+ak --version                     # Show installed version  (-v, -V)
+ak <command> --help              # Show help for a command  (-h)
 ```
 
 ## Exit Codes

package/docs/common/getting-started.md

@@ -13,14 +13,14 @@ This guide walks you through setting up AI Flow Kit for your first project.
 
 ### Global Installation (Recommended for teams)
 ```bash
-npm install -g ai-flow-kit
+npm install -g @relipa/ai-flow-kit
 aiflow --version
 ```
 
 ### Local Installation
 ```bash
 cd your-project
-npm install ai-flow-kit
+npm install @relipa/ai-flow-kit
 npx aiflow --version
 ```
 
@@ -199,7 +199,7 @@ aiflow doctor
 ### "aiflow command not found"
 ```bash
 # If installed globally
-npm install -g ai-flow-kit
+npm install -g @relipa/ai-flow-kit
 
 # If installed locally
 npx aiflow --version

package/docs/common/troubleshooting.md

@@ -8,20 +8,20 @@ Solutions to common issues with AI Flow Kit.
 
 **Global installation:**
 ```bash
-npm install -g ai-flow-kit
+npm install -g @relipa/ai-flow-kit
 aiflow --version
 ```
 
 **Local installation:**
 ```bash
 cd your-project
-npm install ai-flow-kit
+npm install @relipa/ai-flow-kit
 npx aiflow --version
 ```
 
 **Windows cmd/PowerShell:**
 ```cmd
-npm install -g ai-flow-kit
+npm install -g @relipa/ai-flow-kit
 refreshenv
 aiflow --version
 ```
@@ -33,8 +33,8 @@ aiflow --version
 chmod +x ~/.npm/_npx/*/bin/aiflow.js
 
 # Or reinstall globally
-npm uninstall -g ai-flow-kit
-npm install -g ai-flow-kit
+npm uninstall -g @relipa/ai-flow-kit
+npm install -g @relipa/ai-flow-kit
 ```
 
 ---
@@ -52,7 +52,7 @@ npm --version   # Should be 6 or higher
 **Clear npm cache:**
 ```bash
 npm cache clean --force
-npm install -g ai-flow-kit
+npm install -g @relipa/ai-flow-kit
 ```
 
 **Check disk space:**
@@ -589,7 +589,7 @@ touch .aiflow/no-telemetry
 
 ## Quick Fixes Checklist
 
-- [ ] `npm install -g ai-flow-kit` — Fresh install
+- [ ] `npm install -g @relipa/ai-flow-kit` — Fresh install
 - [ ] `aiflow update` — Update to latest
 - [ ] `aiflow doctor` — Verify setup
 - [ ] `aiflow doctor --fix` — Auto-fix issues

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@relipa/ai-flow-kit",
-  "version": "0.0.7",
+  "version": "0.0.8-beta.0",
   "description": "All-in-one AI Flow Kit for team development with Claude AI - skills, templates, and MCP adapters",
   "author": "Example Team",
   "publishConfig": {
@@ -11,6 +11,7 @@
   "type": "commonjs",
   "main": "index.js",
   "bin": {
+    "ak": "./bin/ak.js",
     "aiflow": "./bin/aiflow.js"
   },
   "files": [