Skip to content

Commit 89ef36e

Browse files
committed
README clarifications
1 parent 5f7d11c commit 89ef36e

2 files changed

Lines changed: 13 additions & 3 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
88

99
---
1010

11-
## [0.1.1] — 2026-05-31
11+
## [0.1.1] — 2026-06-01
1212

1313
### ⚠️ BREAKING CHANGE
1414

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,13 +48,15 @@ Watch out developers community. Your paradigm has changed. You trust yourself -
4848
## Using it
4949
**You have to be in root of your repository** (where .git/ resides), otherwise following commands won't work.
5050

51+
After [installation (or even without permanent installation)](1-set-up-the-cli) you can call:
5152
```bash
5253
alcatrazer test # Run bundled tests to verify installation
5354
alcatrazer init # Answer few questions to configure tool
5455
alcatrazer start --run-selftest # start Alcatraz for AI agents (with security invariants check)
5556
alcatrazer visit # visit Alcatraz and tell agents what to do
5657

5758
alcatrazer --help # see all other possibilities
59+
# uvx alcatrazer ... to run it without permanent installation
5860
```
5961

6062
---
@@ -309,6 +311,9 @@ Both modes converge on the exact same package — the only difference is whether
309311
uvx alcatrazer init # or: pipx run alcatrazer init
310312
uvx alcatrazer start # …prefix every command with `uvx `
311313
uvx alcatrazer stop
314+
315+
which alcatrazer # prove ephemeral
316+
alcatrazer not found
312317
```
313318

314319
Each call spins up (or reuses the cached) throwaway venv under `~/.cache/uv/`. **`which alcatrazer` stays empty — that is expected, not broken.** Nothing to uninstall later; the cache is GC'd automatically, or you can force it with `uv cache clean alcatrazer`.
@@ -323,8 +328,13 @@ alcatrazer --version
323328

324329
Then call `alcatrazer <cmd>` directly, as the examples below do.
325330

326-
- Upgrade: `uv tool upgrade alcatrazer` (or `pipx upgrade alcatrazer`)
327-
- Uninstall: `uv tool uninstall alcatrazer` (or `pipx uninstall alcatrazer`)
331+
- Upgrade:
332+
- `uv tool upgrade alcatrazer` or
333+
- `pipx upgrade alcatrazer`)
334+
- Uninstall:
335+
- `uv tool uninstall alcatrazer` or
336+
- `uv pip uninstall alcatrazer` or
337+
- `pipx uninstall alcatrazer`
328338

329339
> The rest of this README uses the short `alcatrazer <cmd>` form. If
330340
> you're in Mode A, prefix every call with `uvx ` (or `pipx run `).

0 commit comments

Comments
 (0)