You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: knowledge.md
+21Lines changed: 21 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -55,6 +55,25 @@ Codebuff is a tool for editing codebases via natural language instruction to Buf
55
55
- ESC key to toggle menu or stop AI response
56
56
- CTRL+C to exit the application
57
57
58
+
### Shell Shims (Direct Commands)
59
+
60
+
Codebuff supports shell shims for direct command invocation without the `codebuff` prefix.
61
+
62
+
-**Cross-platform**: Works on Windows (CMD/PowerShell), macOS, and Linux (bash/zsh/fish)
63
+
-**Store integration**: Uses fully qualified agent IDs from the agent store
64
+
-**Easy management**: Install, update, list, and uninstall shims via CLI commands### Quick Start (Recommended)
65
+
66
+
```bash
67
+
# One-step setup: install and add to PATH automatically
68
+
codebuff shims install codebuff/base-lite@1.0.0
69
+
70
+
# Use immediately in current session (follow the printed instruction)
71
+
eval"$(codebuff shims env)"
72
+
73
+
# Now use direct commands!
74
+
base-lite "fix this bug"# Works right away!
75
+
```
76
+
58
77
## Package Management
59
78
60
79
- Use Bun for all package management operations
@@ -326,11 +345,13 @@ Templates are maintained in the codebuff community repo. Each directory correspo
326
345
**Important**: When adding database indexes or schema changes, modify the schema file directly (`common/src/db/schema.ts`) using Drizzle's index syntax, then run the migration generation script to create the actual migration files.
327
346
328
347
**Do NOT** write migration SQL files directly. The proper workflow is:
348
+
329
349
1. Update `common/src/db/schema.ts` with new indexes using Drizzle syntax
330
350
2. Run the migration generation script to create the SQL migration files
331
351
3. Apply the migrations using the deployment process
0 commit comments