Using the CLI — User Guide
Using the CLI
Section titled “Using the CLI”Quick Reference
- Who: Developer (any skill level)
- Where: Terminal / Shell
- Time: ~2 minutes to complete
- Prerequisites: Bash 4+, target project path
Persona Context
Section titled “Persona Context”This guide is for: Developer Dana
Job To Be Done: Configure documentation tooling for team — “When my team adopts DocKit Master, I want to generate prompts quickly, so that I can paste them into any IDE.”
Process Flow
Section titled “Process Flow”graph TB
S(["Start"])
A["Choose IDE + config"]
B["CLI generates prompt"]
C["Paste into IDE"]
E(["Documentation generated"])
S --> A --> B --> C --> E
Prerequisites
Section titled “Prerequisites”- Bash 4+ installed (macOS:
brew install bash) - Know the absolute path to your target project
- AI IDE installed (Antigravity, Cursor, Claude, etc.)
Step-by-Step Guide
Section titled “Step-by-Step Guide”Step 1: Run the CLI
Section titled “Step 1: Run the CLI”bash scripts/dockit-master.shThe CLI displays an interactive menu with 6 configuration steps.
Step 2: Choose Your IDE
Section titled “Step 2: Choose Your IDE”Select your target AI coding IDE (1–7). Default is Antigravity.
Step 3: Choose Document Type
Section titled “Step 3: Choose Document Type”| Option | Description |
|---|---|
| 1 — knowledge | Personas, JTBD, Process Flows |
| 2 — tech | Architecture, Database, Deployment |
| 3 — sop | Step-by-step user guides |
| 4 — api | API endpoint reference |
| 5 — all | Complete documentation suite (recommended) |
Step 4: Enter Project Path
Section titled “Step 4: Enter Project Path”Provide the absolute path to the project you want to document.
Step 5: Choose Language and Options
Section titled “Step 5: Choose Language and Options”Select output language, SEO optimization, and LLM optimization preferences.
Step 6: Copy the Generated Prompt
Section titled “Step 6: Copy the Generated Prompt”The CLI generates a ready-to-paste prompt and copies it to clipboard (macOS). Paste it into your AI IDE to start generating documentation.
Expected Results
Section titled “Expected Results”- Prompt copied to clipboard
- Ready to paste into target IDE
- Documentation generation begins immediately after pasting
Troubleshooting: "Directory not found" error
Cause: Invalid project path or path contains special characters.
Solution:
- Use absolute paths (starting with
/) - Quote paths with spaces:
"/path/with spaces/project" - Verify the directory exists:
ls /your/path
Troubleshooting: "pbcopy not found" (Linux)
Cause: pbcopy is macOS only.
Solution: Install xclip: sudo apt install xclip and alias: alias pbcopy='xclip -selection clipboard'