Skip to content

Commit cdc7a83

Browse files
avivsinaiclaude
andcommitted
docs: fix documentation for main branch release
- Remove feature branch references from CLI README - Update installation URLs to use main branch - Add CLI documentation section to main README - Add comprehensive examples for CLI usage: - API performance analysis - Security audits - Documentation generation - Migration planning - Test coverage analysis - Architecture review - Quick fixes - Fix markdown linting issues - Update cursor integration with improved templates 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent 6d82d20 commit cdc7a83

28 files changed

+1106
-445
lines changed

.claude/commands/promptcode-ask-expert.md

Lines changed: 0 additions & 157 deletions
This file was deleted.

.claude/commands/promptcode-preset-create.md

Lines changed: 0 additions & 52 deletions
This file was deleted.

.claude/commands/promptcode-preset-info.md

Lines changed: 0 additions & 31 deletions
This file was deleted.

.claude/commands/promptcode-preset-to-prompt.md

Lines changed: 0 additions & 40 deletions
This file was deleted.

CLAUDE.md

Lines changed: 0 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -133,94 +133,3 @@ After recent changes:
133133
- All tests pass - run with `cd packages/cli && bun test`
134134
- To release: Create a tag and push to trigger GitHub Actions
135135
- DO NOT make shortcuts, always use the most idiomatic and generic solution
136-
137-
<!-- PROMPTCODE-CLI-START -->
138-
# PromptCode CLI Integration
139-
140-
This project has PromptCode CLI integrated for AI-assisted code analysis. The CLI provides structured access to the codebase through presets and intelligent commands.
141-
142-
## Available Claude Commands
143-
144-
The following commands are available to help you work with this codebase:
145-
146-
- `/promptcode-preset-list` - List all available code presets
147-
- `/promptcode-preset-info <name>` - Show details and token count for a preset
148-
- `/promptcode-preset-create <description>` - Create a new preset from description
149-
- `/promptcode-preset-to-prompt <preset>` - Export preset to a file
150-
- `/promptcode-ask-expert <question>` - Consult AI expert (or ensemble of experts) with code context
151-
152-
## Quick Examples
153-
154-
```bash
155-
# See what presets are available
156-
/promptcode-preset-list
157-
158-
# Get details about a specific preset
159-
/promptcode-preset-info auth-system
160-
161-
# Create a preset for a feature
162-
/promptcode-preset-create authentication and authorization system
163-
164-
# Ask an expert about the code
165-
/promptcode-ask-expert How does the authentication flow work?
166-
```
167-
168-
## Direct CLI Usage
169-
170-
For simple operations, you can also use the CLI directly:
171-
172-
```bash
173-
# Generate a prompt from files
174-
promptcode generate -f "src/**/*.ts" -o analysis.txt
175-
176-
# Quick expert consultation (requires API key)
177-
promptcode expert "Find security issues" --preset api --yes
178-
179-
# View preset information with JSON output
180-
promptcode preset info backend --json
181-
```
182-
183-
## Ensemble Experts Mode
184-
185-
The `/promptcode-ask-expert` command supports running multiple AI models in parallel:
186-
187-
```bash
188-
# Ensemble mode activates when requesting 2+ models
189-
/promptcode-ask-expert Compare approaches using o3 and gpt-5
190-
/promptcode-ask-expert Analyze with o3, gemini-2.5-pro, and sonnet-4
191-
```
192-
193-
**Features:**
194-
195-
- Runs 2-4 models in parallel with same question
196-
- Synthesizes results showing consensus and unique insights
197-
- Compares cost, speed, and quality across models
198-
- Identifies best value and most comprehensive answers
199-
200-
## Configuration
201-
202-
Set API keys via environment variables for expert consultations:
203-
```bash
204-
export OPENAI_API_KEY=sk-... # For O3/O3-pro models
205-
export ANTHROPIC_API_KEY=sk-... # For Claude models
206-
export GOOGLE_API_KEY=... # For Gemini models
207-
export XAI_API_KEY=... # For Grok models
208-
```
209-
210-
## Cost Protection
211-
212-
The expert command has built-in cost protection:
213-
214-
- Operations over $0.50 require explicit approval
215-
- Premium models (e.g., o3-pro) always require confirmation
216-
- Use `--yes` flag only after getting user approval
217-
218-
<details>
219-
<summary>⚠️ Troubleshooting</summary>
220-
221-
**Command not found** – The CLI auto-installs to `~/.local/bin`. Ensure it's in PATH
222-
**Missing API key** – Set environment variables as shown above
223-
**Context too large** – Use more specific file patterns or focused presets
224-
**Preset not found** – Check `.promptcode/presets/` directory exists
225-
</details>
226-
<!-- PROMPTCODE-CLI-END -->

0 commit comments

Comments
 (0)