Skip to content

Commit 2745715

Browse files
committed
update docs
1 parent 9105b94 commit 2745715

3 files changed

Lines changed: 28 additions & 29 deletions

File tree

CHANGELOG.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1515

1616
### Documentation
1717

18-
- README install section now leads with the `@dev` install command and explains why the plain install will fail until the first stable release ships.
18+
- README install section leads with the plain install command (no `@dev` suffix) now that a stable release is shipping. The dev channel is documented as a prerelease option under `Channels`.
19+
- README `Contributing` links to `AGENTS.md`, `RELEASING.md`, and `CHANGELOG.md` are now absolute GitHub URLs, so they resolve correctly on the npm package page (those docs were never shipped in the tarball).
20+
- README now documents `KILO_API_KEY` as an alias for `KILOCODE_API_KEY` (both have always been accepted by the code).
21+
- Removed the stale "The gateway restarts after device auth" troubleshooting entry. The restart no longer happens after the `reload.noopPrefixes` fix above.
22+
- Exact-version install example updated from `0.1.0-dev.1` to `0.1.0`.
1923
- RELEASING.md documents the first-publish `latest` dist-tag quirk, the workflow's reconciliation step, and what its expected `::warning::` output means.
2024

25+
### Packaging
26+
27+
- Added npm `keywords` to `package.json` (`openclaw`, `kiloclaw`, `kilocode`, `security`) for registry discoverability.
28+
2129
## [0.1.0-dev.1] - 2026-04-15
2230

2331
Initial dev release.

README.md

Lines changed: 13 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -14,31 +14,22 @@ concrete remediation guidance, displayed directly in your chat.
1414
## Install
1515

1616
```bash
17-
openclaw plugins install @kilocode/openclaw-security-advisor@dev
17+
openclaw plugins install @kilocode/openclaw-security-advisor
1818
openclaw plugins enable openclaw-security-advisor
1919
openclaw gateway restart
2020
```
2121

22-
> **Why `@dev`?** No stable release has shipped yet — only dev snapshots
23-
> (`0.1.0-dev.N`). The `@dev` tag is currently the only working install
24-
> path. Plain `openclaw plugins install @kilocode/openclaw-security-advisor`
25-
> (without `@dev`) **will fail today** with a prerelease-guard error,
26-
> because npm's `latest` dist-tag still points at a dev version on
27-
> pre-stable packages. Once the first stable release (`X.Y.Z`) ships,
28-
> you'll be able to drop the `@dev` suffix and use the plain command.
29-
> See [Channels](#channels) below.
30-
3122
On first use, the plugin will walk you through a one-time device auth
3223
flow to connect your KiloCode account.
3324

3425
### Channels
3526

3627
The plugin ships on two npm dist-tags:
3728

38-
- **`latest`**public stable releases (`X.Y.Z`). Default for plain
39-
`npm install` / `openclaw plugins install`. Will exist once the first
40-
stable release ships.
41-
- **`dev`** — internal dogfood snapshots (`X.Y.Z-dev.N`). Install with:
29+
- **`latest`** — stable releases (`X.Y.Z`). Default for plain
30+
`npm install` / `openclaw plugins install`.
31+
- **`dev`** — prerelease snapshots (`X.Y.Z-dev.N`) published ahead of
32+
stable cuts for early testing. Install with:
4233

4334
```bash
4435
openclaw plugins install @kilocode/openclaw-security-advisor@dev
@@ -48,13 +39,11 @@ The plugin ships on two npm dist-tags:
4839

4940
Dev releases are real npm publishes with the same provenance
5041
attestation as stable releases (verify with `npm audit signatures`).
51-
They're "internal" only by social convention and by being on a
52-
non-default dist-tag — there's nothing technically restricting access.
5342

5443
You can also install an exact version directly:
5544

5645
```bash
57-
openclaw plugins install @kilocode/openclaw-security-advisor@0.1.0-dev.1
46+
openclaw plugins install @kilocode/openclaw-security-advisor@0.1.0
5847
```
5948

6049
---
@@ -175,9 +164,10 @@ openclaw config set plugins.entries.openclaw-security-advisor.config.apiBaseUrl
175164
The plugin also respects these environment variables, useful for
176165
non-interactive setups (CI, containerized deployments):
177166

178-
- `KILOCODE_API_KEY`: if set, the plugin uses this as the auth token
179-
and skips the device auth flow entirely. Intended for environments
180-
where an operator has already injected the key at boot.
167+
- `KILOCODE_API_KEY` (alias: `KILO_API_KEY`): if set, the plugin uses
168+
this as the auth token and skips the device auth flow entirely.
169+
Intended for environments where an operator has already injected the
170+
key at boot.
181171
- `KILO_API_URL` or `KILOCODE_API_BASE_URL`: override the API base URL
182172
without touching the plugin config.
183173

@@ -213,18 +203,13 @@ openclaw gateway restart
213203
The plugin itself works without this setting. It's only needed if you
214204
want the `/plugins list` chat command to show installed plugins.
215205

216-
**The gateway restarts after device auth**
217-
This is expected on first auth: the plugin writes your token to the
218-
OpenClaw config, which triggers a one-time gateway reload. Subsequent
219-
checkups don't reload.
220-
221206
---
222207

223208
## Contributing
224209

225-
- [`AGENTS.md`](./AGENTS.md) — build, test, lint, code layout, and contribution rules.
226-
- [`RELEASING.md`](./RELEASING.md) — how to cut a release.
227-
- [`CHANGELOG.md`](./CHANGELOG.md) — release history.
210+
- [`AGENTS.md`](https://github.com/Kilo-Org/openclaw-security-advisor/blob/main/AGENTS.md) — build, test, lint, code layout, and contribution rules.
211+
- [`RELEASING.md`](https://github.com/Kilo-Org/openclaw-security-advisor/blob/main/RELEASING.md) — how to cut a release.
212+
- [`CHANGELOG.md`](https://github.com/Kilo-Org/openclaw-security-advisor/blob/main/CHANGELOG.md) — release history.
228213

229214
---
230215

package.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44
"type": "module",
55
"license": "MIT",
66
"description": "Security analysis plugin for OpenClaw instances, powered by KiloCode",
7+
"keywords": [
8+
"openclaw",
9+
"kiloclaw",
10+
"kilocode",
11+
"security"
12+
],
713
"//": "private: true is intentional — safety net against accidental `npm publish`. The publish script (script/publish.ts) strips this flag before packing and restores it after. Do NOT remove this without also having the publish pipeline in place.",
814
"private": true,
915
"main": "index.ts",

0 commit comments

Comments
 (0)