Add quick reference guide and upgrade script
- docs/QUICK-REFERENCE.md: Comprehensive quick reference card with - All commands organized by category - Shell aliases - Key paths - PA flags - Autonomy levels - Troubleshooting tips - automation/upgrade.sh: Version upgrade management - Check for available upgrades (git-aware) - Pre-upgrade backup creation - Migration runner for version upgrades - Post-upgrade validation - Updated shell completions with 16 aliases total - Test suite now covers 24 tests 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
129
docs/QUICK-REFERENCE.md
Normal file
129
docs/QUICK-REFERENCE.md
Normal file
@@ -0,0 +1,129 @@
|
||||
# Claude Code Quick Reference
|
||||
|
||||
## Commands
|
||||
|
||||
### Core
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `/pa <request>` | Ask the personal assistant |
|
||||
| `/help` | Show all commands and skills |
|
||||
| `/status` | Dashboard overview |
|
||||
| `/config` | View/manage settings |
|
||||
|
||||
### Memory
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `/remember <text>` | Save to memory |
|
||||
| `/search <query>` | Search memory, history, config |
|
||||
| `/summarize` | Summarize session to memory |
|
||||
| `/export [id]` | Export session for sharing |
|
||||
|
||||
### Maintenance
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `/maintain backup` | Create backup |
|
||||
| `/maintain validate` | Validate config |
|
||||
| `/maintain clean` | Clean old files |
|
||||
| `/debug` | Debug report |
|
||||
| `/log` | View logs |
|
||||
| `/mcp-status` | Check MCP integrations |
|
||||
|
||||
### Domain: System
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `/sysadmin:health` | System health check |
|
||||
| `/sysadmin:update` | Update packages |
|
||||
| `/sysadmin:autonomy` | Set autonomy level |
|
||||
|
||||
### Domain: Kubernetes
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `/k8s:cluster-status` | Cluster health |
|
||||
| `/k8s:deploy` | Deploy app |
|
||||
| `/k8s:diagnose` | Troubleshoot |
|
||||
|
||||
### Other
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `/gcal` | Calendar access |
|
||||
| `/usage` | Usage statistics |
|
||||
| `/programmer` | Code development |
|
||||
|
||||
## Shell Aliases
|
||||
|
||||
After sourcing completions:
|
||||
|
||||
```bash
|
||||
claude-status # Quick dashboard
|
||||
claude-validate # Validate config
|
||||
claude-backup # Create backup
|
||||
claude-restore # Restore backup
|
||||
claude-clean # Clean old files
|
||||
claude-search # Search memory
|
||||
claude-history # Browse sessions
|
||||
claude-memory-add # Add to memory
|
||||
claude-memory-list # List memory
|
||||
claude-log # View logs
|
||||
claude-debug # Debug report
|
||||
claude-export # Export session
|
||||
claude-mcp # MCP status
|
||||
claude-test # Run tests
|
||||
claude-install # First-time setup
|
||||
claude-maintenance # Run maintenance
|
||||
```
|
||||
|
||||
## Key Paths
|
||||
|
||||
```
|
||||
~/.claude/
|
||||
├── CLAUDE.md # Agent instructions
|
||||
├── VERSION # Current version
|
||||
├── automation/ # Scripts and tools
|
||||
├── state/
|
||||
│ ├── component-registry.json # Routing config
|
||||
│ ├── personal-assistant/
|
||||
│ │ ├── memory/ # Preferences, decisions, etc.
|
||||
│ │ └── history/ # Session history
|
||||
│ └── sysadmin/ # Sysadmin state
|
||||
├── skills/ # Skill definitions
|
||||
├── commands/ # Command definitions
|
||||
├── agents/ # Agent personas
|
||||
├── workflows/ # Workflow definitions
|
||||
├── hooks/ # Event hooks
|
||||
└── logs/ # Log files
|
||||
```
|
||||
|
||||
## PA Flags
|
||||
|
||||
```
|
||||
/pa --context none|minimal|moderate|comprehensive -- <request>
|
||||
/pa --remember -- "<instruction>"
|
||||
/pa --list-mem
|
||||
/pa --forget <uuid>
|
||||
/pa --show-config
|
||||
```
|
||||
|
||||
## Autonomy Levels
|
||||
|
||||
| Level | Behavior |
|
||||
|-------|----------|
|
||||
| `conservative` | Confirm all writes (default) |
|
||||
| `balanced` | Confirm destructive only |
|
||||
| `aggressive` | Auto-execute most |
|
||||
| `autonomous` | Full auto (careful!) |
|
||||
|
||||
Set with: `/sysadmin:autonomy <level>`
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
1. **Config issues?** → `claude-validate`
|
||||
2. **Something broken?** → `claude-debug`
|
||||
3. **Check integrations?** → `claude-mcp`
|
||||
4. **View what happened?** → `claude-log`
|
||||
5. **Restore backup?** → `claude-restore`
|
||||
|
||||
## Getting Help
|
||||
|
||||
- `/help` - List all commands
|
||||
- `/pa help me with <topic>` - Ask for guidance
|
||||
- Check `~/.claude/docs/` for documentation
|
||||
Reference in New Issue
Block a user