getcompanion-ai/co-mono
1
0
Fork 0
mirror of https://github.com/getcompanion-ai/co-mono.git synced 2026-04-15 06:04:40 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

feat(coding-agent): export keyHint utilities for extensions (#802)

Browse source
This commit is contained in:
Danila Poyarkov 2026-01-17 12:51:03 +03:00 • committed by GitHub
parent 7f9cf543d5
commit 58eec55154
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 31 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

22
packages/coding-agent/docs/extensions.md
View file

@ -1276,6 +1276,28 @@ renderResult(result, { expanded, isPartial }, theme) {
}
```
#### Keybinding Hints
Use `keyHint()` to display keybinding hints that respect user's keybinding configuration:
```typescript
import { keyHint } from "@mariozechner/pi-coding-agent";
renderResult(result, { expanded }, theme) {
let text = theme.fg("success", "✓ Done");
if (!expanded) {
text += ` (${keyHint("expandTools", "to expand")})`;
}
return new Text(text, 0, 0);
}
```
Available functions:
- `keyHint(action, description)` - Editor actions (e.g., `"expandTools"`, `"selectConfirm"`)
- `appKeyHint(keybindings, action, description)` - App actions (requires `KeybindingsManager`)
- `editorKey(action)` - Get raw key string for editor action
- `rawKeyHint(key, description)` - Format a raw key string
#### Best Practices
- Use `Text` with padding `(0, 0)` - the Box handles padding