Skip to content

Commit aa00b75

Browse files
committed
docs: clarify publish policy and cobra CLI UX
1 parent ced6728 commit aa00b75

2 files changed

Lines changed: 19 additions & 6 deletions

File tree

docs/PUBLISHING.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,10 @@ This project is publishable as the npm package `@rama_nigg/open-cursor`. The bin
1010

1111
## Release Checklist
1212

13-
1. Update version in `package.json` (semver).
13+
1. Decide if this is a publish-worthy change.
14+
- Docs-only or refactors with no user-visible behavior change: do not publish.
15+
- User-visible changes (plugin behavior, installer behavior, CLI behavior): publish.
16+
2. Update version in `package.json` (semver) only when publishing.
1417
2. Build and run tests locally:
1518
- `bun install`
1619
- `bun run build`
@@ -37,3 +40,9 @@ Publish step:
3740
- `npm publish --access public`
3841

3942
If you need a non-publish validation run, execute the same build/test steps locally and use `npm pack --dry-run`.
43+
44+
## Dist Tags (Optional)
45+
46+
Use dist-tags for pre-releases instead of publishing a rapid stream of patch versions:
47+
- `latest`: stable releases
48+
- `beta`: pre-release channel (for example `2.2.0-beta.1`)

docs/implementation/open-cursor-go-cli-cobra.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,11 @@ Reference implementation style: `/home/nomadx/Documents/jellywatch/cmd/jellywatc
2525
Binary name: `open-cursor`
2626

2727
Commands:
28-
- `open-cursor install`
28+
- `open-cursor install` (idempotent)
29+
- Configure OpenCode for Cursor in one step. This is safe to re-run any time.
2930
- Ensure plugin file exists: `~/.config/opencode/plugin/cursor-acp.js` (or XDG equivalent)
3031
- Ensure provider config exists/merged in `opencode.json` (baseURL + models)
32+
- Sync models from `cursor-agent models` into the config (no separate script required)
3133
- Best-effort ensure `@ai-sdk/openai-compatible` is installed in `~/.config/opencode`
3234
- `open-cursor sync-models`
3335
- Run `cursor-agent models`, update provider models in config
@@ -39,14 +41,17 @@ Commands:
3941
- Optional (later): `open-cursor doctor`
4042
- Validate cursor-agent presence, login state, and common misconfigurations
4143

42-
Flags (consistent across install/sync/uninstall):
44+
Flags (keep v1 simple):
4345
- `--config <path>` default `$XDG_CONFIG_HOME/opencode/opencode.json` (else `~/.config/opencode/opencode.json`)
4446
- `--plugin-dir <path>` default `$XDG_CONFIG_HOME/opencode/plugin`
45-
- `--base-url <url>` default `http://127.0.0.1:32124/v1`
4647
- `--copy` copy plugin-entry instead of symlink
47-
- `--skip-models` (install only)
4848
- `--no-backup`
4949

50+
Advanced (optional; only add if needed):
51+
- `--base-url <url>` override proxy baseURL (default `http://127.0.0.1:32124/v1`).
52+
Rationale: users running the proxy on a different host/port.
53+
- `--skip-models` skip `cursor-agent models` (useful for CI or offline installs).
54+
5055
Backups:
5156
- Always create `<config>.bak.<timestamp>` unless `--no-backup`.
5257

@@ -98,4 +103,3 @@ Add a small integration test harness in Go:
98103

99104
Do not publish to npm for docs-only changes.
100105
Only publish when user-facing behavior changes (plugin behavior, installer behavior, CLI behavior).
101-

0 commit comments

Comments
 (0)