@shllg/emend 0.1.0 → 0.2.0

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.
package/README.md CHANGED
@@ -43,8 +43,7 @@ one-time sign-in link. The two `claude plugin` lines add the skills to Claude Co
43
43
  If `node --version` is older than 24.18 or `git --version` older than 2.44, as on many Linux
44
44
  distributions and with Apple's git on macOS, follow step 1 of
45
45
  [local.md](https://github.com/shllg/emend/blob/release/docs/setup/local.md#1-install-nodejs-and-git)
46
- first. If your agents run in a sandbox, read
47
- [Use with sandboxed agents](https://github.com/shllg/emend#use-with-sandboxed-agents) next.
46
+ first.
48
47
 
49
48
  The full walkthrough, with a prompt that lets Claude Code or Codex do it with you, is
50
49
  [docs/setup/local.md](https://github.com/shllg/emend/blob/release/docs/setup/local.md).
@@ -60,7 +59,8 @@ one-prompt setup.
60
59
  | [One machine](https://github.com/shllg/emend/blob/release/docs/setup/local.md) | You try emend or review agent work on the machine where the agents run. |
61
60
  | [Your own hub on Tailscale](https://github.com/shllg/emend/blob/release/docs/setup/hub-tailscale.md) | You have an always-on machine and want to review from your phone and other devices. |
62
61
  | [Attach more machines](https://github.com/shllg/emend/blob/release/docs/setup/attach.md) | You run a hub and want the agents on your other machines to publish to it. |
63
- | [Set up your agents](https://github.com/shllg/emend/blob/release/docs/setup/agents.md) | emend runs and you want Claude Code, Codex or others to use it, sandbox rules included. |
62
+ | [Set up your agents](https://github.com/shllg/emend/blob/release/docs/setup/agents.md) | emend runs and you want Claude Code, Codex or others to use it. |
63
+ | [Develop emend from a checkout](https://github.com/shllg/emend/blob/release/docs/setup/development.md) | You change emend itself or run it from a clone. |
64
64
  | [Update](https://github.com/shllg/emend/blob/release/docs/setup/update.md) | A new version is out. |
65
65
  | [Troubleshooting](https://github.com/shllg/emend/blob/release/docs/setup/troubleshooting.md) | A setup or update step fails. |
66
66
  | A hub on your own network (a LAN address or your own HTTPS proxy) | Not supported yet; planned. Today Tailscale is the supported way to reach a hub from other devices. |
@@ -81,17 +81,6 @@ run `emend service install` again too.
81
81
  [docs/setup/update.md](https://github.com/shllg/emend/blob/release/docs/setup/update.md) covers the
82
82
  order for a hub and its machines, Node.js upgrades and the phone app.
83
83
 
84
- ## Use with sandboxed agents
85
-
86
- Inside an agent's sandbox, `emend publish`, `wait`, `feedback` and `reply` cannot reach the
87
- emend server or write its state folder, and emend prints a line that points here. Step 3 of
88
- [docs/setup/agents.md](https://github.com/shllg/emend/blob/release/docs/setup/agents.md#3-use-with-sandboxed-agents)
89
- says how to let exactly these four commands leave the sandbox, once per machine. Read what that
90
- allows, and when not to add it, before you do: these commands then run with your full rights.
91
- Add them only when `emend` on your `PATH` is an install no agent can write, never a development
92
- checkout. The rules never cover `pair`, `attach` or `detach`, so an agent cannot pair a device or
93
- attach your machine to a hub.
94
-
95
84
  ## Uninstall
96
85
 
97
86
  Remove what a setup added with its Undo section: [one machine](https://github.com/shllg/emend/blob/release/docs/setup/local.md#undo)
@@ -105,40 +94,11 @@ and publishing docs for review.
105
94
 
106
95
  ## Development
107
96
 
108
- A checkout installs the same way as a release: `pnpm install:local` builds the committed `HEAD` in
109
- a temporary folder, packs it and installs the package. Use a clone that no agent or tool writes to,
110
- review a change before you pull it, and run the command again after each pull.
111
-
112
- ```sh
113
- pnpm install
114
- pnpm install:local
115
- ```
116
-
117
- If you linked `apps/emend/bin/emend` into a folder on your `PATH` before (the earlier development
118
- steps and `install.sh` did), remove that link, and stop every emend server that runs from a
119
- checkout: `pgrep -af '[e]mend.mjs serve'` lists them with their paths (`pgrep -lf` on macOS).
120
- Otherwise the commands your agents run outside their sandbox, and the server that serves the review
121
- app, run the checkout's build, which agents can change.
122
-
123
- With mise on your `PATH`, the package goes to a folder in mise's data folder that `mise link`
124
- registers as `npm:@shllg/emend@local`; pass `--npm` to use `npm install -g` instead. If `emend` is
125
- not on your `PATH` yet, the command prints the folder to add. It also restarts an installed
126
- service, so the new build runs.
127
-
128
- For Claude Code, add the checkout as a plugin marketplace instead of the GitHub one, never both:
129
-
130
- ```text
131
- /plugin marketplace add <path to your checkout>
132
- /plugin install emend@emend
133
- ```
134
-
135
- Claude Code reads the skills from the checkout's `plugin/` folder, uncommitted changes included. A
136
- pulled change takes effect at the next session start or after `/reload-plugins`. For other agents,
137
- run `emend skills install` once; its links point into the installed package.
138
-
139
- `pnpm verify` runs every check. [AGENTS.md](https://github.com/shllg/emend/blob/main/AGENTS.md)
140
- holds the working rules. Maintainers: [docs/releasing.md](https://github.com/shllg/emend/blob/main/docs/releasing.md)
141
- holds the release policy and checklist.
97
+ [Develop emend from a checkout](https://github.com/shllg/emend/blob/release/docs/setup/development.md)
98
+ covers installing from a checkout, the plugin from a checkout and the checks.
99
+ [AGENTS.md](https://github.com/shllg/emend/blob/main/AGENTS.md) holds the working rules.
100
+ Maintainers: [docs/releasing.md](https://github.com/shllg/emend/blob/main/docs/releasing.md) holds
101
+ the release policy and checklist.
142
102
 
143
103
  ## License
144
104