Skip to content

Commit af57cd6

Browse files
authored
docs: add upgrade instructions and dev CLI setup (#6)
1 parent d5dfc0c commit af57cd6

File tree

2 files changed

+47
-1
lines changed

2 files changed

+47
-1
lines changed

DEVELOPER.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,46 @@ cd asta-plugins
8484
make install
8585
```
8686

87+
`make install` creates `.venv/bin/asta` as an editable install — changes to Python source
88+
are picked up immediately, no reinstall needed.
89+
90+
#### Using dev asta from other directories
91+
92+
To use the dev `asta` from any directory, either invoke it directly:
93+
94+
```bash
95+
/path/to/asta-plugins/.venv/bin/asta --help
96+
```
97+
98+
Or activate the venv:
99+
100+
```bash
101+
source /path/to/asta-plugins/.venv/bin/activate
102+
```
103+
104+
If you have a global `asta` installed, it stays unaffected — the venv takes precedence
105+
only while active.
106+
107+
For coding agents like Claude that invoke bare `asta` from arbitrary working directories,
108+
add to `~/.zshrc`:
109+
110+
```bash
111+
alias claude-asta='PATH="/path/to/asta-plugins/.venv/bin:$PATH" claude --plugin-dir /path/to/asta-plugins'
112+
```
113+
114+
The PATH prepend ensures skills resolve `asta` to your local source for that session,
115+
without affecting your global install. If you have the `asta` plugin installed globally,
116+
disable or uninstall it via Claude Code settings while developing to avoid loading it
117+
twice alongside `--plugin-dir`.
118+
119+
#### Picking up changes
120+
121+
| Changed | Action needed |
122+
|---|---|
123+
| Python files (`src/asta/`) | None — editable install |
124+
| `pyproject.toml` (new deps/scripts) | `make install` |
125+
| Skills, hooks, `plugin.json` | Restart `claude-asta` session |
126+
87127
### Run Tests
88128

89129
```bash

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ npx skills add add allenai/asta-plugins/skills
1010
1111
# In Claude Code
1212
> /plugin marketplace add allenai/asta-plugins
13-
> /plugin install asta-plugins
13+
> /plugin install asta
1414
```
1515

1616
### Available Skills
@@ -38,6 +38,12 @@ Install the `asta` CLI tool:
3838
uv tool install git+https://github.com/allenai/asta-plugins.git
3939
```
4040

41+
To upgrade:
42+
43+
```bash
44+
uv tool upgrade asta
45+
```
46+
4147
See `asta --help` for usage instructions.
4248

4349
## Development

0 commit comments

Comments
 (0)