mirror of
https://github.com/getcompanion-ai/co-mono.git
synced 2026-04-20 08:04:44 +00:00
docs(coding-agent): add windows.md and shell-aliases.md
This commit is contained in:
parent
1b98d45c77
commit
82e3be9dc8
2 changed files with 30 additions and 0 deletions
13
packages/coding-agent/docs/shell-aliases.md
Normal file
13
packages/coding-agent/docs/shell-aliases.md
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
# Shell Aliases
|
||||||
|
|
||||||
|
Pi runs bash in non-interactive mode (`bash -c`), which doesn't expand aliases by default.
|
||||||
|
|
||||||
|
To enable your shell aliases, add to `~/.pi/agent/settings.json`:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"shellCommandPrefix": "shopt -s expand_aliases\neval \"$(grep '^alias ' ~/.zshrc)\""
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Adjust the path (`~/.zshrc`, `~/.bashrc`, etc.) to match your shell config.
|
||||||
17
packages/coding-agent/docs/windows.md
Normal file
17
packages/coding-agent/docs/windows.md
Normal file
|
|
@ -0,0 +1,17 @@
|
||||||
|
# Windows Setup
|
||||||
|
|
||||||
|
Pi requires a bash shell on Windows. Checked locations (in order):
|
||||||
|
|
||||||
|
1. Custom path from `~/.pi/agent/settings.json`
|
||||||
|
2. Git Bash (`C:\Program Files\Git\bin\bash.exe`)
|
||||||
|
3. `bash.exe` on PATH (Cygwin, MSYS2, WSL)
|
||||||
|
|
||||||
|
For most users, [Git for Windows](https://git-scm.com/download/win) is sufficient.
|
||||||
|
|
||||||
|
## Custom Shell Path
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"shellPath": "C:\\cygwin64\\bin\\bash.exe"
|
||||||
|
}
|
||||||
|
```
|
||||||
Loading…
Add table
Add a link
Reference in a new issue