Skip to content

Commit a3a31db

Browse files
James Zhuclaude
andcommitted
docs: Update documentation for fancy name generation and enhanced prompt commands
- Update README.md with new prompt command structure and fancy name features - Rewrite QUICK_REFERENCE.md with comprehensive prompt command examples - Update PROMPTS_AND_SKILLS.md with detailed guide for new features - Add CHANGELOG.md entry documenting the new prompt enhancements - Include examples of fancy name generation and new command usage 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 85de48f commit a3a31db

File tree

5 files changed

+117
-101
lines changed

5 files changed

+117
-101
lines changed

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ This file documents repository-level expectations and instructions intended to g
77
- Always test the CLI usages for the change related
88
- Never commit credentials, keys, .env files
99
- After any changes, run the folling to reinstall the project:
10+
- Always update readme, tests and docs for changes
1011
```
1112
rm -rf dist/*
1213
./install.sh uninstall

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ CAM solves this by providing a single, consistent interface to manage everything
3232
- **MCP Registry:** Built-in registry with **381 pre-configured MCP servers** ready to install across all supported tools.
3333
- **Extensible Framework:** Standardized architecture for managing:
3434
- **Agents:** Standalone assistant configurations (markdown-based with YAML front matter).
35-
- **Prompts:** Reusable system prompts synced across assistants at user or project scope.
35+
- **Prompts:** Reusable system prompts with fancy name generation synced across assistants at user or project scope.
3636
- **Skills:** Custom tools and functionalities for your agents (directory-based with SKILL.md).
3737
- **Plugins:** Marketplace extensions for supported assistants (GitHub repos or local paths).
3838
- **MCP Support:** First-class support for the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/), allowing assistants to connect to external data sources and tools.
@@ -206,11 +206,13 @@ cam agent repos # Manage agent repositories
206206
### Prompt Subcommands
207207

208208
```bash
209-
cam prompt list # List saved prompts
210-
cam prompt create # Create a new prompt
211-
cam prompt sync <id> <tool> # Sync a prompt to a tool
212-
cam prompt set-default <id> # Set default prompt for sync-all
213-
cam prompt sync-all # Sync default prompt to all tools
209+
cam prompt list # List all saved prompts
210+
cam prompt add [NAME] -f FILE # Add prompt (auto-generates fancy name ✨)
211+
cam prompt update NAME -f FILE # Update prompt content, name, or settings
212+
cam prompt import --app claude # Import from live app files (fancy names ✨)
213+
cam prompt install NAME --app claude # Install prompt to app files
214+
cam prompt remove NAME # Remove a prompt
215+
cam prompt status # Show where prompts are installed with file paths
214216
```
215217

216218
### Skill Subcommands

docs/CHANGELOG.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,21 @@
11
# Changelog
22

3+
## [Unreleased]
4+
5+
### Added
6+
- **Fancy Name Generation**: ✨ Auto-generate creative prompt names like "Cosmic Coder" or "Quantum Assistant" when adding or importing prompts
7+
- **Enhanced Prompt Update Command**: New `cam prompt update` command with `--file` option to update prompt content, description, name, and default status
8+
- **Improved Prompt Status**: `cam prompt status` now shows file paths alongside app:level information for better visibility
9+
- **Optional Prompt Names**: `cam prompt add` and `cam prompt import` commands now support optional names with automatic fancy name generation
10+
11+
### Changed
12+
- **Prompt CLI Commands**: Updated command structure to be more intuitive:
13+
- `cam prompt add` - Add prompts (auto-generates names if not provided)
14+
- `cam prompt update` - Update existing prompts with content from files
15+
- `cam prompt import` - Import from live app files with fancy names
16+
- `cam prompt install` - Install configured prompts to app files
17+
- `cam prompt status` - Enhanced to show file paths
18+
319
## [1.0.3] - 2024-10-18
420

521
### Changed

docs/PROMPTS_AND_SKILLS.md

Lines changed: 64 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@ Code Assistant Manager includes built-in support for managing **prompts** and **
44

55
## Key Features
66

7-
- **Download skills from GitHub repositories** and install them to `~/.claude/skills/`, `~/.codex/skills/`, or `~/.gemini/skills/`
8-
- **Sync prompts** to the actual tool config files: `~/.claude/CLAUDE.md`, `~/.codex/AGENTS.md`, `~/.gemini/GEMINI.md`
9-
- **Multi-app support**: Claude, Codex (OpenAI), and Gemini
10-
- **Repository-based skill discovery**: Automatically fetch available skills from configured GitHub repositories
7+
- **Fancy name generation**: ✨ Auto-generate creative prompt names like "Cosmic Coder" or "Quantum Assistant"
8+
- **Enhanced prompt management**: Add, update, import, install, and sync prompts across AI assistants
9+
- **Multi-level support**: User-level and project-level prompt management
10+
- **File-based operations**: Read from and write to prompt files directly
11+
- **Status tracking**: See exactly where prompts are installed with file paths
1112

1213
## Prompts
1314

@@ -16,29 +17,24 @@ Prompts are reusable text templates that you can apply to any AI assistant. They
1617
### Quick Start
1718

1819
```bash
19-
# Import the current user-level live prompt from Claude
20-
cam prompt import-live --app claude
20+
# Add a new prompt (auto-generates fancy name if none provided)
21+
cam prompt add -f my-prompt.md # ✨ Generates creative name
22+
cam prompt add "My Expert Coder" -f my-prompt.md
2123

22-
# Import the current project-level prompt from the working directory
23-
cam prompt import-live --app claude --level project --project-dir $(pwd)
24+
# Import all live prompts from all apps (auto-generates fancy names)
25+
cam prompt import --app all --level all
2426

25-
# Import every live prompt (all apps + levels)
26-
cam prompt import-live --app all --level all --project-dir $(pwd)
27+
# Update an existing prompt
28+
cam prompt update "My Prompt" -f updated-prompt.md --description "New version"
2729

28-
# Show the project-level prompt file content
29-
cam prompt show-live --app claude --level project --project-dir $(pwd)
30+
# Install prompts to specific apps
31+
cam prompt install "My Prompt" --app claude --level user
32+
33+
# Check where prompts are installed with file paths
34+
cam prompt status
3035

3136
# List all prompts
3237
cam prompt list
33-
34-
# Create a new prompt
35-
cam prompt create my-prompt --name "My Expert Coder" --file my-prompt.md
36-
37-
# Activate a prompt (writes to CLAUDE.md, AGENTS.md, or GEMINI.md)
38-
cam prompt activate my-prompt --app claude
39-
40-
# Show what's currently in the user-level live file
41-
cam prompt show-live --app claude
4238
```
4339

4440
### Prompt File Locations
@@ -60,83 +56,77 @@ cam prompt ls # shorthand
6056
cam p list # alias
6157
```
6258

63-
#### View a specific prompt
59+
#### Add a new prompt
6460
```bash
65-
cam prompt view <prompt-id>
66-
```
61+
# Interactive mode (auto-generates fancy name)
62+
cam prompt add
6763

68-
#### Create a new prompt
69-
```bash
70-
# Interactive mode (prompts for content)
71-
cam prompt create my-prompt --name "My Prompt" --description "My description"
64+
# From a file (auto-generates fancy name)
65+
cam prompt add -f path/to/prompt.md
7266

73-
# From a file
74-
cam prompt create my-prompt --name "My Prompt" --file path/to/prompt.txt
75-
```
67+
# From a file with custom name
68+
cam prompt add "My Custom Prompt" -f path/to/prompt.md
7669

77-
#### Update a prompt
78-
```bash
79-
cam prompt update <prompt-id> --name "New Name" --description "New description"
80-
cam prompt update <prompt-id> --file path/to/new-content.txt
81-
```
70+
# From stdin with custom name
71+
cat prompt.md | cam prompt add "My Prompt"
8272

83-
#### Delete a prompt
84-
```bash
85-
cam prompt delete <prompt-id>
86-
cam prompt delete <prompt-id> --force # Skip confirmation
73+
# With description
74+
cam prompt add "Expert Coder" -f prompt.md -d "Advanced coding assistant"
8775
```
8876

89-
#### Activate/Deactivate prompts (syncs to app files)
77+
#### Update a prompt
9078
```bash
91-
# Activate a prompt and sync it to Claude's CLAUDE.md (user scope)
92-
cam prompt activate my-prompt --app claude
93-
94-
# Activate for Codex (syncs to AGENTS.md)
95-
cam prompt activate my-prompt --app codex
79+
# Update content from file
80+
cam prompt update "My Prompt" -f new-content.md
9681

97-
# Activate for Gemini (syncs to GEMINI.md)
98-
cam prompt activate my-prompt --app gemini
82+
# Update description and name
83+
cam prompt update "My Prompt" --description "Updated description" --name "New Name"
9984

100-
# Activate at the project scope (writes ./CLAUDE.md, ./AGENTS.md, or ./GEMINI.md)
101-
cam prompt activate my-prompt --app claude --level project --project-dir $(pwd)
85+
# Set/unset as default prompt
86+
cam prompt update "My Prompt" --default
87+
cam prompt update "My Prompt" --no-default
10288

103-
# Deactivate a prompt
104-
cam prompt deactivate my-prompt
89+
# Update multiple properties at once
90+
cam prompt update "My Prompt" -f updated.md --name "Better Name" --default
10591
```
10692

107-
#### Sync all active prompts
93+
#### Import prompts from live app files
10894
```bash
109-
cam prompt sync
110-
```
95+
# Import from Claude (auto-generates fancy name)
96+
cam prompt import --app claude
11197

112-
#### Import from live file
113-
```bash
114-
# Import current CLAUDE.md as a new prompt
115-
cam prompt import-live --app claude --name "Imported Prompt"
98+
# Import with custom name
99+
cam prompt import "My Claude Prompt" --app claude
116100

117-
# Import the prompt stored in the current project's CLAUDE.md
118-
cam prompt import-live --app claude --level project --project-dir $(pwd) --name "Project Prompt"
101+
# Import from specific level
102+
cam prompt import --app claude --level project
119103

120-
# Import all user/project prompts for every app
121-
cam prompt import-live --app all --level all --project-dir $(pwd)
104+
# Import from all apps and levels (bulk import)
105+
cam prompt import --app all --level all
106+
```
122107

123-
# Show current user-level live content
124-
cam prompt show-live --app claude
108+
#### Install prompts to app files
109+
```bash
110+
# Install to Claude user level
111+
cam prompt install "My Prompt" --app claude --level user
125112

126-
# Show the project-level prompt content
127-
cam prompt show-live --app claude --level project --project-dir $(pwd)
113+
# Install to project level
114+
cam prompt install "My Prompt" --app claude --level project
128115

129-
# Show every prompt file across all apps and levels
130-
cam prompt show-live --app all --level all --project-dir $(pwd)
116+
# Install to multiple apps
117+
cam prompt install "My Prompt" --app claude
118+
cam prompt install "My Prompt" --app copilot
131119
```
132120

133-
#### Import/Export prompts
121+
#### Remove a prompt
134122
```bash
135-
# Export to JSON file
136-
cam prompt export --file ~/my-prompts.json
123+
cam prompt remove "My Prompt"
124+
cam prompt remove "My Prompt" --force # Skip confirmation
125+
```
137126

138-
# Import from JSON file
139-
cam prompt import --file ~/my-prompts.json
127+
#### Check prompt status
128+
```bash
129+
cam prompt status # Shows where prompts are installed with file paths
140130
```
141131

142132
## Skills

docs/QUICK_REFERENCE.md

Lines changed: 28 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -5,37 +5,44 @@
55
### Basic Operations
66
```bash
77
# List all prompts
8-
cam prompt list # or: cam p list
8+
cam prompt list # or: cam p list, cam p ls
99

10-
# View a prompt
11-
cam prompt view <id>
12-
13-
# Create a new prompt
14-
cam prompt create <id> --name "Name" --description "Description"
10+
# Add a new prompt (interactive or from file)
11+
cam prompt add "My Prompt" -f prompt.md # From file
12+
cam prompt add -f prompt.md # Auto-generate fancy name ✨
1513

1614
# Update a prompt
17-
cam prompt update <id> --name "New Name"
15+
cam prompt update "My Prompt" -f updated.md --description "New desc"
16+
cam prompt edit "My Prompt" -f updated.md # Alias
1817

19-
# Delete a prompt
20-
cam prompt delete <id>
21-
```
18+
# Import prompts from live app files
19+
cam prompt import --app claude # Auto-generate fancy name ✨
20+
cam prompt import "My Claude" --app claude # Custom name
2221

23-
### Enable/Disable
24-
```bash
25-
# Enable a prompt
26-
cam prompt enable <id>
22+
# Install prompts to app files
23+
cam prompt install "My Prompt" --app claude --level user
24+
25+
# Remove a prompt
26+
cam prompt remove "My Prompt"
2727

28-
# Disable a prompt
29-
cam prompt disable <id>
28+
# Show prompt status (where installed, file paths)
29+
cam prompt status
3030
```
3131

32-
### Import/Export
32+
### Advanced Operations
3333
```bash
34-
# Export all prompts
35-
cam prompt export --file ~/prompts.json
34+
# Import all live prompts from all apps
35+
cam prompt import --app all --level all
36+
37+
# Update prompt content from file
38+
cam prompt update "My Prompt" --file new-content.md
39+
40+
# Change prompt name or description
41+
cam prompt update "My Prompt" --name "New Name" --description "Updated"
3642

37-
# Import prompts
38-
cam prompt import --file ~/prompts.json
43+
# Set/unset as default prompt
44+
cam prompt update "My Prompt" --default
45+
cam prompt update "My Prompt" --no-default
3946
```
4047

4148
## Skill Commands

0 commit comments

Comments
 (0)