ws-aitoolkit 0.1.7__tar.gz → 0.1.8__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/PKG-INFO +55 -51
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/README.md +53 -49
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/pyproject.toml +2 -2
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/pyproject.toml.orig +2 -2
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/__init__.py +1 -1
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/_build.py +2 -2
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/adapters/__init__.py +29 -10
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/adapters/claude_code.py +52 -31
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/adapters/opencode.py +11 -4
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/adapters/opencode_plugin.py +4 -2
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/approvals.py +3 -4
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/brand.py +1 -1
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/broker.py +5 -6
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/canary.py +16 -15
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/cli.py +10 -2
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/config_cmd.py +10 -5
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/doctor.py +36 -4
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/eval.py +152 -19
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/evalstats.py +229 -14
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/gate.py +69 -26
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/guards/__init__.py +4 -4
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/guards/claims.py +15 -6
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/guards/record_calls.py +3 -4
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/guards/session_context.py +1 -1
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/guards/skill_gate.py +1 -1
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/guards/spawn_cap.py +1 -1
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/guards/syntax_check.py +6 -2
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/home/api.py +6 -6
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/home/sources/ws_approvals.py +3 -3
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/home/sources/ws_eval.py +1 -1
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/home/sources/ws_runs.py +1 -1
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/home/sources/ws_sessions.py +4 -4
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/install.py +47 -35
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/jobs.py +3 -4
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/memory.py +4 -4
- ws_aitoolkit-0.1.8/src/ws/migrate.py +615 -0
- ws_aitoolkit-0.1.8/src/ws/paths.py +519 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/policy.py +803 -84
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/profile.py +3 -6
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/rating.py +7 -8
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/roles/__init__.py +1 -1
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/roles/_schedule.py +6 -7
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/roles/commands.py +13 -7
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/roles/launchd.py +2 -4
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/roles/ntfy.py +8 -8
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/roles/restic.py +3 -3
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/roles/systemd.py +4 -7
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/run.py +39 -44
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/runrecord.py +3 -4
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/sandbox.py +58 -31
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/secrets.py +8 -8
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/session.py +55 -33
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/shellwords.py +93 -19
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/skills/__init__.py +6 -6
- ws_aitoolkit-0.1.8/src/ws/unknownpath.py +289 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/userconfig.py +96 -19
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/version.py +21 -3
- ws_aitoolkit-0.1.8/src/ws/wallsettings.py +283 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/LICENSE +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/NOTICE +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/__main__.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/devices.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/extcmd.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/frontmatter.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/gatecorpus.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/globals.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/guards/_paths.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/guards/bulk_staging.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/guards/checkout_pin.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/guards/dev_server.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/guards/test_weakening.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/home/__init__.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/home/cli.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/home/records.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/home/sources/__init__.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/home/sources/_files.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/home/sources/asks_jsonl.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/home/sources/claude_code.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/home/sources/collie.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/home/sources/events_dir.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/home/sources/opencode.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/home/sources/otel_jsonl.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/home/sources/transcripts.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/home/sources/ws_plugins.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/jsonl.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/mcp_server.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/modules.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/notes.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/notesdetect.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/osinfo.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/output.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/roles/anthropic.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/roles/markdown_git.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/roles/notify_none.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/roles/opencode.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/roles/secrets_env.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/roles/secrets_ws.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/roles/sops_age.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/runschema.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/selfcmd.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/setup_ui/__init__.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/setup_ui/flow.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/setup_ui/inline.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/setup_ui/web.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/skills/align.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/skills/checkpoint.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/skills/dataviz.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/skills/resume.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/skills/ship.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/skills/taste_gate.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/status.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/style.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/term/__init__.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/term/app.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/term/assets.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/term/bridge.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/term/cli.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/term/keys.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/term/page.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/term/testing.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/term/tmux.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/term/websocket.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/testing/__init__.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/testing/mockprovider.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/testing/scenarios.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/ui/__init__.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/ui/components.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/ui/css.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/ui/server.py +0 -0
- {ws_aitoolkit-0.1.7 → ws_aitoolkit-0.1.8}/src/ws/usage.py +0 -0
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: ws-aitoolkit
|
|
3
|
-
Version: 0.1.
|
|
4
|
-
Summary: Your memory, skills and rules,
|
|
3
|
+
Version: 0.1.8
|
|
4
|
+
Summary: Your memory, skills and rules, across your AI coding tools.
|
|
5
5
|
Author: Michael Fry
|
|
6
6
|
License-Expression: Apache-2.0
|
|
7
7
|
License-File: LICENSE
|
|
@@ -19,7 +19,7 @@ Project-URL: Issues, https://github.com/Michael-A-Fry/ws/issues
|
|
|
19
19
|
Project-URL: Security, https://github.com/Michael-A-Fry/ws/blob/main/SECURITY.md
|
|
20
20
|
Description-Content-Type: text/markdown
|
|
21
21
|
|
|
22
|
-
# ws: Your memory, skills and rules,
|
|
22
|
+
# ws: Your memory, skills and rules, across your AI coding tools
|
|
23
23
|
|
|
24
24
|
[](https://pypi.org/project/ws-aitoolkit/)
|
|
25
25
|
[](https://pypi.org/project/ws-aitoolkit/)
|
|
@@ -35,7 +35,7 @@ Linux. On Windows it runs inside WSL2.
|
|
|
35
35
|
|
|
36
36
|
## Install
|
|
37
37
|
|
|
38
|
-
Run the installer. It checks the machine, installs the `ws` command with uv or pipx, and runs a smoke test.
|
|
38
|
+
Run the installer. It checks the machine, installs the `ws` command with uv (or pipx), and runs a smoke test.
|
|
39
39
|
|
|
40
40
|
```sh
|
|
41
41
|
curl -fsSL https://raw.githubusercontent.com/Michael-A-Fry/ws/main/install.sh | bash
|
|
@@ -44,10 +44,12 @@ curl -fsSL https://raw.githubusercontent.com/Michael-A-Fry/ws/main/install.sh |
|
|
|
44
44
|
Or install the package yourself:
|
|
45
45
|
|
|
46
46
|
```sh
|
|
47
|
-
|
|
47
|
+
uv tool install ws-aitoolkit
|
|
48
48
|
```
|
|
49
49
|
|
|
50
|
-
|
|
50
|
+
There are three release channels: `stable` (the default), `rc` for release candidates and `edge` for the `main` branch.
|
|
51
|
+
`install.sh --channel rc` or `--channel edge` picks one. For those, and for a pinned version, see
|
|
52
|
+
[Install ws](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/how-to/install.md).
|
|
51
53
|
|
|
52
54
|
## First command
|
|
53
55
|
|
|
@@ -68,16 +70,16 @@ the roles you set up (runner, model, budget, secrets, memory, notes, scheduler,
|
|
|
68
70
|
Doctor exits with 1 while anything needs doing, so a new install exits with 1. Run `ws init` to answer the three setup
|
|
69
71
|
questions, or `ws setup` to go step by step. `ws doctor --json` gives the same report for scripts.
|
|
70
72
|
|
|
71
|
-
To follow a whole first session, see the [first-run tutorial](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
73
|
+
To follow a whole first session, see the [first-run tutorial](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/tutorials/first-run.md).
|
|
72
74
|
|
|
73
75
|
## Skills
|
|
74
76
|
|
|
75
77
|
`ws install` puts six skills in your runner's skills folder: `align`, `checkpoint`, `taste-gate`, `dataviz`, `resume`
|
|
76
78
|
and `ship`. `ws skills` lists them per runner. A skill you already have under one of those names stays as it is.
|
|
77
79
|
|
|
78
|
-
To use ws's version of a name you already have, run `ws skills adopt NAME`. Yours moves to
|
|
79
|
-
|
|
80
|
-
back.
|
|
80
|
+
To use ws's version of a name you already have, run `ws skills adopt NAME`. Yours moves to `backups/skills/<runner>/` in
|
|
81
|
+
ws's state folder (`~/.local/state/ws`) and ws installs its own. `ws skills restore NAME` takes ws's copy out and moves
|
|
82
|
+
yours back.
|
|
81
83
|
|
|
82
84
|
## Verify
|
|
83
85
|
|
|
@@ -87,9 +89,9 @@ Check which build you have:
|
|
|
87
89
|
ws version --json
|
|
88
90
|
```
|
|
89
91
|
|
|
90
|
-
The output has `version`, `git_sha`, `dirty`, `build_date`, `python`, `install_path` and `install_source`.
|
|
91
|
-
carries a checksum, a build provenance attestation, a Sigstore bundle and an SBOM. To check them, see
|
|
92
|
-
[Verify a release](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
92
|
+
The output has `version`, `channel`, `git_sha`, `dirty`, `build_date`, `python`, `install_path` and `install_source`.
|
|
93
|
+
Each release carries a checksum, a build provenance attestation, a Sigstore bundle and an SBOM. To check them, see
|
|
94
|
+
[Verify a release](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/how-to/verify-a-release.md).
|
|
93
95
|
|
|
94
96
|
## Troubleshooting
|
|
95
97
|
|
|
@@ -100,55 +102,57 @@ carries a checksum, a build provenance attestation, a Sigstore bundle and an SBO
|
|
|
100
102
|
| Native Windows | ws runs inside WSL2. Run `wsl --install -d Ubuntu-24.04`, then run the installer in that shell. |
|
|
101
103
|
| `ws` isn't found after the install | Run `uv tool update-shell` or `pipx ensurepath`, then open a new terminal. |
|
|
102
104
|
|
|
103
|
-
For more, see [Troubleshoot ws](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
105
|
+
For more, see [Troubleshoot ws](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/how-to/troubleshoot.md).
|
|
104
106
|
|
|
105
107
|
## Documentation
|
|
106
108
|
|
|
107
|
-
Start with the [documentation map](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
109
|
+
Start with the [documentation map](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/README.md). Pages are grouped as tutorials, how-to guides, explanation and
|
|
108
110
|
reference (the [Diátaxis](https://diataxis.fr/) split).
|
|
109
111
|
|
|
110
112
|
| Page | What it covers |
|
|
111
113
|
|---|---|
|
|
112
|
-
| [Usage](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
113
|
-
| [First run](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
114
|
-
| [Install](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
115
|
-
| [Verify a release](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
116
|
-
| [Upgrade and uninstall](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
117
|
-
| [Troubleshoot](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
118
|
-
| [Use the gate](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
119
|
-
| [Use the wall](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
120
|
-
| [Approve a command](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
121
|
-
| [Store a secret](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
122
|
-
| [Apply the Rule of Two](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
123
|
-
| [Set a budget](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
124
|
-
| [Send drafts only](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
125
|
-
| [Run an eval](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
126
|
-
| [The gate](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
127
|
-
| [The wall](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
128
|
-
| [Approvals](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
129
|
-
| [The broker](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
130
|
-
| [The Rule of Two](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
131
|
-
| [Budget](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
132
|
-
| [Draft-only sending](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
133
|
-
| [Known limits](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
134
|
-
| [Write-up 1](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
135
|
-
| [
|
|
136
|
-
| [
|
|
137
|
-
| [
|
|
138
|
-
| [
|
|
139
|
-
| [
|
|
140
|
-
| [
|
|
141
|
-
| [
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
114
|
+
| [Usage](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/usage.md) | Every command, one task each |
|
|
115
|
+
| [First run](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/tutorials/first-run.md) | Install, check, set up and run a first task |
|
|
116
|
+
| [Install](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/how-to/install.md) | Install options and pinning a version |
|
|
117
|
+
| [Verify a release](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/how-to/verify-a-release.md) | Checksum, attestation, Sigstore bundle |
|
|
118
|
+
| [Upgrade and uninstall](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/how-to/upgrade-and-uninstall.md) | Move to a new version, or remove ws |
|
|
119
|
+
| [Troubleshoot](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/how-to/troubleshoot.md) | Install and doctor failures |
|
|
120
|
+
| [Use the gate](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/how-to/use-the-gate.md) | Turn the policy into each runner's rules |
|
|
121
|
+
| [Use the wall](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/how-to/use-the-wall.md) | Run a runner inside the sandbox |
|
|
122
|
+
| [Approve a command](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/how-to/approve-a-command.md) | Give a refused call a single-use yes |
|
|
123
|
+
| [Store a secret](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/how-to/store-a-secret.md) | Keep a key where agents can't read it |
|
|
124
|
+
| [Apply the Rule of Two](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/how-to/apply-the-rule-of-two.md) | Limit what one session can combine |
|
|
125
|
+
| [Set a budget](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/how-to/set-a-budget.md) | Cap spend per month |
|
|
126
|
+
| [Send drafts only](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/how-to/send-drafts-only.md) | Let agents draft, never send |
|
|
127
|
+
| [Run an eval](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/how-to/run-an-eval.md) | Compare two setups on your own tasks |
|
|
128
|
+
| [The gate](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/explanation/gate.md) | How policy becomes enforcement |
|
|
129
|
+
| [The wall](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/explanation/wall.md) | What the sandbox stops and what it doesn't |
|
|
130
|
+
| [Approvals](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/explanation/approvals.md) | Why an approval is bound and single-use |
|
|
131
|
+
| [The broker](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/explanation/broker.md) | Why agents never see a secret |
|
|
132
|
+
| [The Rule of Two](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/explanation/rule-of-two.md) | The design rule behind the policy |
|
|
133
|
+
| [Budget](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/explanation/budget.md) | How caps are counted |
|
|
134
|
+
| [Draft-only sending](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/explanation/draft-only-sending.md) | Why ws never sends for you |
|
|
135
|
+
| [Known limits](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/explanation/known-limits.md) | What ws doesn't protect against yet |
|
|
136
|
+
| [Write-up 1](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/explanation/write-up-1.md) | The design and what we measured |
|
|
137
|
+
| [Decision records](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/decisions/README.md) | Why each engine choice was made |
|
|
138
|
+
| [CLI reference](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/reference/cli.md) | Every command and flag |
|
|
139
|
+
| [Doctor checks](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/reference/doctor-checks.md) | Every check ID |
|
|
140
|
+
| [Policy reference](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/reference/policy.md) | Every `policy.toml` key |
|
|
141
|
+
| [Eval reference](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/reference/eval.md) | Task format, graders, metrics |
|
|
142
|
+
| [Lab reference](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/reference/lab.md) | The lab machine and the launch matrix |
|
|
143
|
+
| [`ws version --json`](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/reference/version-json.md) | The fields of the version report |
|
|
144
|
+
| [Principles](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/reference/principles.md) | The rules ws follows and the check for each |
|
|
145
|
+
| [Code map](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/reference/code-map.md) | What each module is for |
|
|
146
|
+
|
|
147
|
+
For contributors: [CONTRIBUTING.md](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/CONTRIBUTING.md), [SECURITY.md](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/SECURITY.md), [SUPPORT.md](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/SUPPORT.md),
|
|
148
|
+
[CHANGELOG.md](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/CHANGELOG.md) and [AGENTS.md](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/AGENTS.md).
|
|
145
149
|
|
|
146
150
|
## Status
|
|
147
151
|
|
|
148
152
|
ws is pre-1.0. Commands, JSON output and `policy.toml` keys can still change between releases, and the
|
|
149
|
-
[CHANGELOG](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
150
|
-
[Known limits](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
153
|
+
[CHANGELOG](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/CHANGELOG.md) says when they do. Doctor IDs never change meaning once released. Read
|
|
154
|
+
[Known limits](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/explanation/known-limits.md) before you rely on the wall or the gate.
|
|
151
155
|
|
|
152
156
|
## Licence
|
|
153
157
|
|
|
154
|
-
ws is [Apache-2.0](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
158
|
+
ws is [Apache-2.0](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/LICENSE). Contributions need the [CLA](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/CLA.md), signed through a bot on your first pull request.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# ws: Your memory, skills and rules,
|
|
1
|
+
# ws: Your memory, skills and rules, across your AI coding tools
|
|
2
2
|
|
|
3
3
|
[](https://pypi.org/project/ws-aitoolkit/)
|
|
4
4
|
[](https://pypi.org/project/ws-aitoolkit/)
|
|
@@ -14,7 +14,7 @@ Linux. On Windows it runs inside WSL2.
|
|
|
14
14
|
|
|
15
15
|
## Install
|
|
16
16
|
|
|
17
|
-
Run the installer. It checks the machine, installs the `ws` command with uv or pipx, and runs a smoke test.
|
|
17
|
+
Run the installer. It checks the machine, installs the `ws` command with uv (or pipx), and runs a smoke test.
|
|
18
18
|
|
|
19
19
|
```sh
|
|
20
20
|
curl -fsSL https://raw.githubusercontent.com/Michael-A-Fry/ws/main/install.sh | bash
|
|
@@ -23,10 +23,12 @@ curl -fsSL https://raw.githubusercontent.com/Michael-A-Fry/ws/main/install.sh |
|
|
|
23
23
|
Or install the package yourself:
|
|
24
24
|
|
|
25
25
|
```sh
|
|
26
|
-
|
|
26
|
+
uv tool install ws-aitoolkit
|
|
27
27
|
```
|
|
28
28
|
|
|
29
|
-
|
|
29
|
+
There are three release channels: `stable` (the default), `rc` for release candidates and `edge` for the `main` branch.
|
|
30
|
+
`install.sh --channel rc` or `--channel edge` picks one. For those, and for a pinned version, see
|
|
31
|
+
[Install ws](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/how-to/install.md).
|
|
30
32
|
|
|
31
33
|
## First command
|
|
32
34
|
|
|
@@ -47,16 +49,16 @@ the roles you set up (runner, model, budget, secrets, memory, notes, scheduler,
|
|
|
47
49
|
Doctor exits with 1 while anything needs doing, so a new install exits with 1. Run `ws init` to answer the three setup
|
|
48
50
|
questions, or `ws setup` to go step by step. `ws doctor --json` gives the same report for scripts.
|
|
49
51
|
|
|
50
|
-
To follow a whole first session, see the [first-run tutorial](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
52
|
+
To follow a whole first session, see the [first-run tutorial](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/tutorials/first-run.md).
|
|
51
53
|
|
|
52
54
|
## Skills
|
|
53
55
|
|
|
54
56
|
`ws install` puts six skills in your runner's skills folder: `align`, `checkpoint`, `taste-gate`, `dataviz`, `resume`
|
|
55
57
|
and `ship`. `ws skills` lists them per runner. A skill you already have under one of those names stays as it is.
|
|
56
58
|
|
|
57
|
-
To use ws's version of a name you already have, run `ws skills adopt NAME`. Yours moves to
|
|
58
|
-
|
|
59
|
-
back.
|
|
59
|
+
To use ws's version of a name you already have, run `ws skills adopt NAME`. Yours moves to `backups/skills/<runner>/` in
|
|
60
|
+
ws's state folder (`~/.local/state/ws`) and ws installs its own. `ws skills restore NAME` takes ws's copy out and moves
|
|
61
|
+
yours back.
|
|
60
62
|
|
|
61
63
|
## Verify
|
|
62
64
|
|
|
@@ -66,9 +68,9 @@ Check which build you have:
|
|
|
66
68
|
ws version --json
|
|
67
69
|
```
|
|
68
70
|
|
|
69
|
-
The output has `version`, `git_sha`, `dirty`, `build_date`, `python`, `install_path` and `install_source`.
|
|
70
|
-
carries a checksum, a build provenance attestation, a Sigstore bundle and an SBOM. To check them, see
|
|
71
|
-
[Verify a release](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
71
|
+
The output has `version`, `channel`, `git_sha`, `dirty`, `build_date`, `python`, `install_path` and `install_source`.
|
|
72
|
+
Each release carries a checksum, a build provenance attestation, a Sigstore bundle and an SBOM. To check them, see
|
|
73
|
+
[Verify a release](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/how-to/verify-a-release.md).
|
|
72
74
|
|
|
73
75
|
## Troubleshooting
|
|
74
76
|
|
|
@@ -79,55 +81,57 @@ carries a checksum, a build provenance attestation, a Sigstore bundle and an SBO
|
|
|
79
81
|
| Native Windows | ws runs inside WSL2. Run `wsl --install -d Ubuntu-24.04`, then run the installer in that shell. |
|
|
80
82
|
| `ws` isn't found after the install | Run `uv tool update-shell` or `pipx ensurepath`, then open a new terminal. |
|
|
81
83
|
|
|
82
|
-
For more, see [Troubleshoot ws](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
84
|
+
For more, see [Troubleshoot ws](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/how-to/troubleshoot.md).
|
|
83
85
|
|
|
84
86
|
## Documentation
|
|
85
87
|
|
|
86
|
-
Start with the [documentation map](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
88
|
+
Start with the [documentation map](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/README.md). Pages are grouped as tutorials, how-to guides, explanation and
|
|
87
89
|
reference (the [Diátaxis](https://diataxis.fr/) split).
|
|
88
90
|
|
|
89
91
|
| Page | What it covers |
|
|
90
92
|
|---|---|
|
|
91
|
-
| [Usage](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
92
|
-
| [First run](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
93
|
-
| [Install](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
94
|
-
| [Verify a release](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
95
|
-
| [Upgrade and uninstall](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
96
|
-
| [Troubleshoot](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
97
|
-
| [Use the gate](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
98
|
-
| [Use the wall](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
99
|
-
| [Approve a command](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
100
|
-
| [Store a secret](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
101
|
-
| [Apply the Rule of Two](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
102
|
-
| [Set a budget](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
103
|
-
| [Send drafts only](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
104
|
-
| [Run an eval](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
105
|
-
| [The gate](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
106
|
-
| [The wall](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
107
|
-
| [Approvals](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
108
|
-
| [The broker](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
109
|
-
| [The Rule of Two](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
110
|
-
| [Budget](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
111
|
-
| [Draft-only sending](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
112
|
-
| [Known limits](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
113
|
-
| [Write-up 1](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
114
|
-
| [
|
|
115
|
-
| [
|
|
116
|
-
| [
|
|
117
|
-
| [
|
|
118
|
-
| [
|
|
119
|
-
| [
|
|
120
|
-
| [
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
93
|
+
| [Usage](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/usage.md) | Every command, one task each |
|
|
94
|
+
| [First run](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/tutorials/first-run.md) | Install, check, set up and run a first task |
|
|
95
|
+
| [Install](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/how-to/install.md) | Install options and pinning a version |
|
|
96
|
+
| [Verify a release](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/how-to/verify-a-release.md) | Checksum, attestation, Sigstore bundle |
|
|
97
|
+
| [Upgrade and uninstall](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/how-to/upgrade-and-uninstall.md) | Move to a new version, or remove ws |
|
|
98
|
+
| [Troubleshoot](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/how-to/troubleshoot.md) | Install and doctor failures |
|
|
99
|
+
| [Use the gate](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/how-to/use-the-gate.md) | Turn the policy into each runner's rules |
|
|
100
|
+
| [Use the wall](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/how-to/use-the-wall.md) | Run a runner inside the sandbox |
|
|
101
|
+
| [Approve a command](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/how-to/approve-a-command.md) | Give a refused call a single-use yes |
|
|
102
|
+
| [Store a secret](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/how-to/store-a-secret.md) | Keep a key where agents can't read it |
|
|
103
|
+
| [Apply the Rule of Two](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/how-to/apply-the-rule-of-two.md) | Limit what one session can combine |
|
|
104
|
+
| [Set a budget](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/how-to/set-a-budget.md) | Cap spend per month |
|
|
105
|
+
| [Send drafts only](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/how-to/send-drafts-only.md) | Let agents draft, never send |
|
|
106
|
+
| [Run an eval](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/how-to/run-an-eval.md) | Compare two setups on your own tasks |
|
|
107
|
+
| [The gate](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/explanation/gate.md) | How policy becomes enforcement |
|
|
108
|
+
| [The wall](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/explanation/wall.md) | What the sandbox stops and what it doesn't |
|
|
109
|
+
| [Approvals](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/explanation/approvals.md) | Why an approval is bound and single-use |
|
|
110
|
+
| [The broker](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/explanation/broker.md) | Why agents never see a secret |
|
|
111
|
+
| [The Rule of Two](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/explanation/rule-of-two.md) | The design rule behind the policy |
|
|
112
|
+
| [Budget](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/explanation/budget.md) | How caps are counted |
|
|
113
|
+
| [Draft-only sending](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/explanation/draft-only-sending.md) | Why ws never sends for you |
|
|
114
|
+
| [Known limits](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/explanation/known-limits.md) | What ws doesn't protect against yet |
|
|
115
|
+
| [Write-up 1](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/explanation/write-up-1.md) | The design and what we measured |
|
|
116
|
+
| [Decision records](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/decisions/README.md) | Why each engine choice was made |
|
|
117
|
+
| [CLI reference](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/reference/cli.md) | Every command and flag |
|
|
118
|
+
| [Doctor checks](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/reference/doctor-checks.md) | Every check ID |
|
|
119
|
+
| [Policy reference](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/reference/policy.md) | Every `policy.toml` key |
|
|
120
|
+
| [Eval reference](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/reference/eval.md) | Task format, graders, metrics |
|
|
121
|
+
| [Lab reference](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/reference/lab.md) | The lab machine and the launch matrix |
|
|
122
|
+
| [`ws version --json`](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/reference/version-json.md) | The fields of the version report |
|
|
123
|
+
| [Principles](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/reference/principles.md) | The rules ws follows and the check for each |
|
|
124
|
+
| [Code map](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/reference/code-map.md) | What each module is for |
|
|
125
|
+
|
|
126
|
+
For contributors: [CONTRIBUTING.md](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/CONTRIBUTING.md), [SECURITY.md](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/SECURITY.md), [SUPPORT.md](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/SUPPORT.md),
|
|
127
|
+
[CHANGELOG.md](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/CHANGELOG.md) and [AGENTS.md](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/AGENTS.md).
|
|
124
128
|
|
|
125
129
|
## Status
|
|
126
130
|
|
|
127
131
|
ws is pre-1.0. Commands, JSON output and `policy.toml` keys can still change between releases, and the
|
|
128
|
-
[CHANGELOG](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
129
|
-
[Known limits](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
132
|
+
[CHANGELOG](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/CHANGELOG.md) says when they do. Doctor IDs never change meaning once released. Read
|
|
133
|
+
[Known limits](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/docs/explanation/known-limits.md) before you rely on the wall or the gate.
|
|
130
134
|
|
|
131
135
|
## Licence
|
|
132
136
|
|
|
133
|
-
ws is [Apache-2.0](https://github.com/Michael-A-Fry/ws/blob/v0.1.
|
|
137
|
+
ws is [Apache-2.0](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/LICENSE). Contributions need the [CLA](https://github.com/Michael-A-Fry/ws/blob/v0.1.8/CLA.md), signed through a bot on your first pull request.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
[project]
|
|
2
2
|
name = "ws-aitoolkit"
|
|
3
|
-
version = "0.1.
|
|
4
|
-
description = "Your memory, skills and rules,
|
|
3
|
+
version = "0.1.8"
|
|
4
|
+
description = "Your memory, skills and rules, across your AI coding tools."
|
|
5
5
|
readme = "README.md"
|
|
6
6
|
license = "Apache-2.0"
|
|
7
7
|
license-files = [
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
[project]
|
|
2
2
|
name = "ws-aitoolkit"
|
|
3
|
-
version = "0.1.
|
|
4
|
-
description = "Your memory, skills and rules,
|
|
3
|
+
version = "0.1.8"
|
|
4
|
+
description = "Your memory, skills and rules, across your AI coding tools."
|
|
5
5
|
readme = "README.md"
|
|
6
6
|
license = "Apache-2.0"
|
|
7
7
|
license-files = ["LICENSE", "NOTICE"]
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
"""ws: your memory, skills and rules,
|
|
1
|
+
"""ws: your memory, skills and rules, across your AI coding tools."""
|
|
2
2
|
|
|
3
3
|
# Aliased: a bare `version` here would be the package attribute `ws.version`, which is the `ws version` module.
|
|
4
4
|
from importlib.metadata import PackageNotFoundError
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"""Written by the release workflow before uv build; absent in a checkout."""
|
|
2
2
|
|
|
3
|
-
git_sha = "
|
|
3
|
+
git_sha = "185abf5d9e3bebf8febdbc4c7b24260147703db6"
|
|
4
4
|
dirty = False
|
|
5
|
-
build_date = "2026-11-
|
|
5
|
+
build_date = "2026-11-08T01:06:35Z"
|
|
6
6
|
source = "release"
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
A module must define:
|
|
4
4
|
|
|
5
5
|
NAME: str the --runner name, e.g. "claude-code"
|
|
6
|
-
def generate(policy, ws_cmd, out, policy_file, *, protect=()) -> dict
|
|
6
|
+
def generate(policy, ws_cmd, out, policy_file, *, protect=(), pin=None) -> dict
|
|
7
7
|
file name (relative to the out dir) -> text; pure, no I/O.
|
|
8
8
|
`ws_cmd` is the argv list that runs ws, e.g. ["ws"]; `out` is the
|
|
9
9
|
folder the files go in and `policy_file` the policy they came from:
|
|
@@ -11,6 +11,8 @@ A module must define:
|
|
|
11
11
|
them (see check_argv for the hook's side of that). `protect` names
|
|
12
12
|
more paths a session may not write (deny rules, the hook's
|
|
13
13
|
--protect arguments, the sandbox's denyWrite).
|
|
14
|
+
`pin` is the `ws.paths.Pin` the hook carries (None: the one this
|
|
15
|
+
environment resolves to); see check_argv.
|
|
14
16
|
def parse(payload) -> Call | list[Call] | None
|
|
15
17
|
a hook payload from that runner, as neutral Call(s); None if the call
|
|
16
18
|
is not one the policy governs; ValueError or TypeError if it cannot be
|
|
@@ -35,6 +37,8 @@ from dataclasses import dataclass, field
|
|
|
35
37
|
from pathlib import Path
|
|
36
38
|
from types import MappingProxyType, ModuleType
|
|
37
39
|
|
|
40
|
+
from ws import paths
|
|
41
|
+
|
|
38
42
|
|
|
39
43
|
@dataclass(frozen=True)
|
|
40
44
|
class Call:
|
|
@@ -74,26 +78,41 @@ def get(name: str) -> ModuleType:
|
|
|
74
78
|
|
|
75
79
|
def protected_paths(out: Path, policy_file: Path, extra: tuple[str, ...] = ()) -> list[str]:
|
|
76
80
|
"""Everything a session must not write: the generated folder, the policy, ws's other control files next to
|
|
77
|
-
it (profile, secrets, jobs, release, runs, logs),
|
|
78
|
-
|
|
81
|
+
it (profile, secrets, jobs, release, runs, logs), every folder ws keeps its files in (in each layout it could use:
|
|
82
|
+
`ws.paths.protected_roots`), and any `extra` path the caller names (a user settings file). Each adapter denies edits
|
|
83
|
+
to all of them natively."""
|
|
79
84
|
from ws.policy import control_paths
|
|
80
85
|
|
|
81
|
-
|
|
82
|
-
|
|
86
|
+
found = [
|
|
87
|
+
str(out),
|
|
88
|
+
str(policy_file),
|
|
89
|
+
*control_paths(policy_file.parent),
|
|
90
|
+
*paths.control_paths(),
|
|
91
|
+
*map(str, paths.protected_roots()),
|
|
92
|
+
*extra,
|
|
93
|
+
]
|
|
94
|
+
return list(dict.fromkeys(found))
|
|
83
95
|
|
|
84
96
|
|
|
85
97
|
def check_argv(
|
|
86
|
-
ws_cmd: list[str],
|
|
98
|
+
ws_cmd: list[str],
|
|
99
|
+
runner: str,
|
|
100
|
+
policy_file: Path,
|
|
101
|
+
out: Path,
|
|
102
|
+
protect: tuple[str, ...] = (),
|
|
103
|
+
pin: paths.Pin | None = None,
|
|
87
104
|
) -> list[str]:
|
|
88
105
|
"""The command a generated hook or shim runs. The policy and the protected folder are absolute paths, so the hook
|
|
89
106
|
reads the same policy wherever the runner starts and cannot be pointed at another one by the session's cwd. Each
|
|
90
|
-
`protect` path is one more `--protect`.
|
|
107
|
+
`protect` path is one more `--protect`. `--pin` carries the layout `ws install` resolved (the home folder and ws's
|
|
108
|
+
four folders): the hook uses only that, and refuses when the environment it runs in resolves to another.
|
|
109
|
+
"""
|
|
91
110
|
argv = [*ws_cmd, "gate", "check", "--runner", runner, "--policy", str(policy_file), "--protect", str(out)]
|
|
92
111
|
for p in protect:
|
|
93
112
|
argv += ["--protect", str(p)]
|
|
94
|
-
return argv
|
|
113
|
+
return [*argv, *(pin or paths.pin_of()).args()]
|
|
95
114
|
|
|
96
115
|
|
|
97
|
-
def event_argv(ws_cmd: list[str], runner: str, policy_file: Path) -> list[str]:
|
|
116
|
+
def event_argv(ws_cmd: list[str], runner: str, policy_file: Path, pin: paths.Pin | None = None) -> list[str]:
|
|
98
117
|
"""The command a generated hook runs for the events that are not a tool call's check: `ws gate event`."""
|
|
99
|
-
return [*ws_cmd, "gate", "event", "--runner", runner, "--policy", str(policy_file)]
|
|
118
|
+
return [*ws_cmd, "gate", "event", "--runner", runner, "--policy", str(policy_file), *(pin or paths.pin_of()).args()]
|