58 lines
1.5 KiB
Markdown
58 lines
1.5 KiB
Markdown
# Ollie Acme Commands
|
|
|
|
These scripts integrate ollie with the acme text editor. They use the acme 9P
|
|
filesystem to read selections and send prompts to ollie.
|
|
|
|
## Prerequisites
|
|
|
|
- An active ollie session with `$session` and `$agent` environment variables set
|
|
- The `o` script in PATH
|
|
- plan9port's `9p` command
|
|
|
|
## Commands
|
|
|
|
| Command | Selection Required | Description |
|
|
|---------|-------------------|-------------|
|
|
| OllieHere | No | Start or select an Ollie session for the current directory |
|
|
| AskFile | No | Describe and explain the current file |
|
|
| Explain | Yes | Explain the selected code |
|
|
| Document | Yes | Add documentation comments to selected code |
|
|
| Fix | Yes | Fix issues in the selected code |
|
|
| Refactor | Yes | Refactor the selected code |
|
|
| AddTests | Yes | Write unit tests for the selected code |
|
|
| SendVerbatim | Yes | Send selection as-is (wrapped in code fence) |
|
|
|
|
## Installation
|
|
|
|
Add the scripts directory to your PATH or symlink them to a directory in PATH:
|
|
|
|
```
|
|
export PATH="$PATH:/path/to/ollie/data/scripts/acme"
|
|
```
|
|
|
|
Or symlink individual commands:
|
|
|
|
```
|
|
ln -s /path/to/ollie/data/scripts/acme/* ~/bin/
|
|
```
|
|
|
|
## Usage
|
|
|
|
1. Start an ollie session and set environment:
|
|
```
|
|
eval $(o env mysession myagent)
|
|
```
|
|
|
|
2. In acme, add the commands to your window's tag:
|
|
```
|
|
OllieHere AskFile Explain Fix Refactor Document AddTests SendVerbatim
|
|
```
|
|
|
|
3. For commands requiring selection, select text first, then middle-click the command.
|
|
|
|
## Example Tag
|
|
|
|
```
|
|
$HOME/project/main.go Del Snarf Undo Put | AskFile Explain Fix Refactor
|
|
```
|