@apicircle/cli 1.0.9 → 1.1.2
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 +38 -6
- package/dist/bin/cli.cjs +1666 -101
- package/dist/bin/cli.cjs.map +1 -1
- package/dist/bin/cli.js +3 -1
- package/dist/bin/cli.js.map +1 -1
- package/dist/{chunk-H4VHFKVH.js → chunk-E4QK7ACO.js} +3 -2
- package/dist/{chunk-H4VHFKVH.js.map → chunk-E4QK7ACO.js.map} +1 -1
- package/dist/index.cjs +1601 -94
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +1610 -97
- package/dist/index.js.map +1 -1
- package/package.json +7 -6
package/README.md
CHANGED
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
|
|
12
12
|
<p align="center">
|
|
13
13
|
<a href="https://www.npmjs.com/package/@apicircle/cli"><img src="https://img.shields.io/npm/v/@apicircle/cli?color=cb3837&logo=npm" alt="npm version" /></a>
|
|
14
|
-
<img src="https://img.shields.io/badge/subcommands-
|
|
14
|
+
<img src="https://img.shields.io/badge/subcommands-9-blue" alt="9 subcommands" />
|
|
15
15
|
<img src="https://img.shields.io/badge/runs-CI%20%C2%B7%20Docker%20%C2%B7%20SSH%20%C2%B7%20local-success" alt="Runs everywhere" />
|
|
16
16
|
<img src="https://img.shields.io/badge/node-%E2%89%A5%2020-brightgreen" alt="Node ≥ 20" />
|
|
17
17
|
</p>
|
|
@@ -77,11 +77,7 @@ There are two ways the CLI finds a workspace:
|
|
|
77
77
|
|
|
78
78
|
The flags are **mutually exclusive** — passing both is an error.
|
|
79
79
|
|
|
80
|
-
The registry root defaults to
|
|
81
|
-
|
|
82
|
-
- **Windows** — `%APPDATA%\@apicircle\desktop\workspaces\`
|
|
83
|
-
- **macOS** — `~/Library/Application Support/@apicircle/desktop/workspaces/`
|
|
84
|
-
- **Linux** — `~/.config/@apicircle/desktop/workspaces/`
|
|
80
|
+
The registry root defaults to `~/.apicircle/` (user home directory on every OS).
|
|
85
81
|
|
|
86
82
|
Override with `APICIRCLE_WORKSPACES_ROOT` for CI / tests.
|
|
87
83
|
|
|
@@ -188,6 +184,42 @@ fails closed instead of sending a partial upload.
|
|
|
188
184
|
aborted), `2` usage error, `3` denied by the authorization gate. Pipelines
|
|
189
185
|
gate on it directly.
|
|
190
186
|
|
|
187
|
+
### `apicircle linked` — manage linked workspaces
|
|
188
|
+
|
|
189
|
+
```bash
|
|
190
|
+
# List linked workspaces in the active workspace
|
|
191
|
+
apicircle linked list
|
|
192
|
+
|
|
193
|
+
# Link a private source repo at a specific version
|
|
194
|
+
apicircle linked link octo-org/payments --branch main --pinned-version 1.2.0 \
|
|
195
|
+
--token $GITHUB_TOKEN
|
|
196
|
+
|
|
197
|
+
# Re-pull the cached release ledger (+ snapshot if missing)
|
|
198
|
+
apicircle linked refresh <linkedWorkspaceId>
|
|
199
|
+
|
|
200
|
+
# Unlink (drops cached ledger + overrides + snapshot)
|
|
201
|
+
apicircle linked unlink <linkedWorkspaceId>
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
Tokens come from `--token` or `GITHUB_TOKEN`. Public links can fetch
|
|
205
|
+
anonymously; private links require a token.
|
|
206
|
+
|
|
207
|
+
### `apicircle release` — tag releases / edit topics
|
|
208
|
+
|
|
209
|
+
```bash
|
|
210
|
+
# Tag v1.2.0 on the repo's default-branch HEAD (optionally create a GitHub Release)
|
|
211
|
+
apicircle release tag octo-org/payments 1.2.0 --release --notes "Hotfix for /charges"
|
|
212
|
+
|
|
213
|
+
# Replace an existing tag of the same name
|
|
214
|
+
apicircle release tag octo-org/payments 1.2.0 --override
|
|
215
|
+
|
|
216
|
+
# List topics (the `apicircle` topic drives marketplace discovery)
|
|
217
|
+
apicircle release topics octo-org/payments
|
|
218
|
+
|
|
219
|
+
# Replace topics (always keeps `apicircle`)
|
|
220
|
+
apicircle release topics octo-org/payments --set "payments,billing"
|
|
221
|
+
```
|
|
222
|
+
|
|
191
223
|
## Common workflows
|
|
192
224
|
|
|
193
225
|
**Set up a new workspace from scratch**
|