@farthershore/cli 0.43.0 → 0.45.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/CHANGELOG.md CHANGED
@@ -1,9 +1,49 @@
1
1
  # Changelog — @farthershore/cli
2
2
 
3
+ All notable changes to the `farthershore` CLI are documented here. The CLI
4
+ versions independently from the SDKs. Pre-1.0: minor versions may include
5
+ breaking changes. Releases before 0.35.0 are recorded only in the git history.
6
+
7
+ ## [Unreleased]
8
+
9
+ ## [0.45.0] - 2026-11-21
10
+
11
+ ### Added — connect a backend with one key
12
+
13
+ - `backend bind` defaults to the business's default backend, returns its
14
+ receiver URL, and shows the default `FS_SECRET_KEY` once when issued.
15
+ - Backend deployments and keys support `--for` scope selection across
16
+ production and preview environments; token operations include
17
+ `webhook_secrets` for automatic webhook verification.
18
+
19
+ ### Added
20
+
21
+ - `farthershore webhook redeliver <business> <webhookId> <deliveryId>` sends
22
+ one delivery again (same `webhook-id`).
23
+ - `farthershore webhook redeliver-failed <business> <webhookId> --since <time>
24
+ [--until <time>]` sends every failed or dead delivery in the window again.
25
+ Times are ISO-8601 or a span back from now (`30m`, `24h`, `7d`).
26
+
27
+ ### Changed
28
+
29
+ - Webhook endpoint output carries `pausedAt` instead of `disabledAt`.
30
+ Requires the matching platform release.
31
+
32
+ ## [0.44.0] - 2026-11-20
33
+
34
+ - Add `farthershore organization seller-details show`: the seller details every business in the organization shows its customers, read from the organization's Stripe account.
35
+ - Add `farthershore account export` to download your own personal data as JSON, and `farthershore account deletion-status` to follow an account deletion started in the dashboard.
36
+ - Add `farthershore consumer export` to export one customer's data as JSON, and `farthershore consumer erasure-status` to read the status of that customer's data erasure.
37
+ - Add `farthershore legal status` to read whether the platform's current legal documents have been accepted.
38
+
3
39
  ## [0.43.0] - 2026-11-18
4
40
 
5
41
  - Global npm installs on macOS and Linux silently check npm latest hourly after successful commands. Upgrade-required responses update and re-run once (not when the command read stdin). pnpm and Windows installs are not updated automatically.
6
42
  - Add `farthershore update`, `FARTHERSHORE_NO_UPDATE=1`, and `autoUpdate: false` configuration (a config file with only `autoUpdate` is valid). CI and unowned installs skip automatic updates.
43
+ - **Breaking:** Removed `business rollback` and the retired BusinessApply/Rollback workflow filters. Recover a Business contract through a reviewed repository fix and a new release.
44
+ - Protect configuration lock recovery and release with owner identity; identify reused processes and explain safe manual recovery when ownership cannot be confirmed.
45
+ - Serialize concurrent link and notice updates; warn when older directory links need explicit relinking with `farthershore link <business>`.
46
+ - Write configuration atomically, reject corrupt configuration, and scope directory links and saved organization selection to the API URL.
7
47
 
8
48
  > A CLI published to `latest` must work against the Core running in
9
49
  > production at publish time. A CLI that needs an unreleased Core is
@@ -14,20 +54,6 @@
14
54
 
15
55
  - Use `/agent/v1/whoami` for login and credential validation after retirement of `/management`. Core now requires CLI 0.42.0 or newer.
16
56
 
17
- All notable changes to the `farthershore` CLI are documented here. The CLI
18
- versions independently from the SDKs. Pre-1.0: minor versions may include
19
- breaking changes. Releases before 0.35.0 are recorded only in the git history.
20
-
21
- ## [Unreleased]
22
-
23
- - **Breaking:** Removed `business rollback` and the retired BusinessApply/Rollback workflow filters. Recover a Business contract through a reviewed repository fix and a new release.
24
-
25
- - Protect configuration lock recovery and release with owner identity; identify reused processes and explain safe manual recovery when ownership cannot be confirmed.
26
-
27
- - Serialize concurrent link and notice updates; warn when older directory links need explicit relinking with `farthershore link <business>`.
28
-
29
- - Write configuration atomically, reject corrupt configuration, and scope directory links and saved organization selection to the API URL.
30
-
31
57
  ## [0.41.0] - 2026-11-09
32
58
 
33
59
  - **Breaking:** `business rollback` now sends `publishId` and reads
@@ -36,6 +62,8 @@ breaking changes. Releases before 0.35.0 are recorded only in the git history.
36
62
 
37
63
  ## [0.40.0] - 2026-11-06
38
64
 
65
+ - **Breaking:** Rename `backend tokens` to `backend keys`, code-mode `runtimeTokens` to `secretKeys`, and runtime credential configuration to `FS_SECRET_KEY`. Issued `fsrt_` keys retain their wire format.
66
+
39
67
  - **Breaking:** Organization deletion, ownership transfer and Stripe disconnection now direct callers to the dashboard. Business deletion is available only to the stage CLI; human-only methods are removed from code mode and the API client.
40
68
 
41
69
  ### Added
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Farther Shore
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -3,7 +3,7 @@
3
3
  Create and operate [FartherShore](https://farthershore.com) software businesses
4
4
  from the terminal.
5
5
 
6
- **Status: `0.43.0`.** Pre-1.0 — the command surface is stable but may still
6
+ **Status: `0.45.0`.** Pre-1.0 — the command surface is stable but may still
7
7
  change between minor versions. Pin an exact version in CI.
8
8
 
9
9
  FartherShore lets you define a software business as code, then sells, meters,
@@ -20,13 +20,13 @@ takes `--format json` for non-interactive scripting.
20
20
  ## Install
21
21
 
22
22
  ```bash
23
- npm install -g @farthershore/cli@0.43.0
23
+ npm install -g @farthershore/cli@0.45.0
24
24
  ```
25
25
 
26
26
  Or run it directly with npx:
27
27
 
28
28
  ```bash
29
- npx -p @farthershore/cli@0.43.0 farthershore --help
29
+ npx -p @farthershore/cli@0.45.0 farthershore --help
30
30
  ```
31
31
 
32
32
  ## Authentication
@@ -195,7 +195,7 @@ farthershore docs ls sdks/connect-your-application --format json
195
195
  farthershore docs read sdks/connect-your-application/metering --format json
196
196
  farthershore docs ls sdks/connect-your-application/metering --format json
197
197
  farthershore docs read backend/metering --section "choose-the-correct-metering-channel" --format json
198
- farthershore docs search "runtime token" --collection sdks --limit 10 --format json
198
+ farthershore docs search "secret key" --collection sdks --limit 10 --format json
199
199
  farthershore docs collection sdks --format json
200
200
  ```
201
201
 
@@ -713,9 +713,9 @@ cannot use the inherited secret.
713
713
 
714
714
  ### `farthershore backend`
715
715
 
716
- Create bring-your-own backends and provision runtime tokens for your upstream
716
+ Create bring-your-own backends and provision secret keys for your upstream
717
717
  services. Only token hashes are stored; the raw token is returned once and should
718
- be deployed as `FS_RUNTIME_TOKEN`.
718
+ be deployed as `FS_SECRET_KEY`.
719
719
 
720
720
  ```bash
721
721
  farthershore backend list weather-api --format json
@@ -725,11 +725,11 @@ farthershore backend create weather-api \
725
725
  --format json
726
726
  farthershore backend bind weather-api api \
727
727
  --env preview-42 \
728
- --origin-url https://api-pr-42.example.com \
728
+ --origin https://api-pr-42.example.com \
729
729
  --format json
730
- farthershore backend tokens create weather-api --backend <backendId> --format json
731
- farthershore backend tokens rotate weather-api <tokenId> --yes --format json
732
- farthershore backend tokens revoke weather-api <tokenId> --yes --format json
730
+ farthershore backend keys create weather-api --backend <backendId> --format json
731
+ farthershore backend keys rotate weather-api <tokenId> --yes --format json
732
+ farthershore backend keys revoke weather-api <tokenId> --yes --format json
733
733
  ```
734
734
 
735
735
  Pair the token with
@@ -859,7 +859,7 @@ farthershore skills install
859
859
  ```
860
860
 
861
861
  If the platform-owned skills installer is unavailable, stop and ask the human to run
862
- `npm install -g @farthershore/cli@0.43.0`, then repeat the installer help check.
862
+ `npm install -g @farthershore/cli@0.45.0`, then repeat the installer help check.
863
863
  The CLI keeps itself current (see Staying up to date); do not otherwise install
864
864
  or upgrade global tooling autonomously.
865
865
 
@@ -953,14 +953,14 @@ back — the intermediate data never has to pass through a transcript.
953
953
 
954
954
  ```bash
955
955
  # 1. Find operations (ranked by name, path, summary and description).
956
- farthershore code search runtime token --format json
956
+ farthershore code search secret key --format json
957
957
 
958
958
  # 2. Read one: description, TypeScript signature, safety flags, reconcile
959
959
  # read, required permission and a runnable example.
960
- farthershore code describe runtimeTokens.revoke
960
+ farthershore code describe secretKeys.revoke
961
961
 
962
962
  # 3. Load the types you need (or the whole API) before writing the script.
963
- farthershore code types runtimeTokens > fs.d.ts
963
+ farthershore code types secretKeys > fs.d.ts
964
964
 
965
965
  # 4. Run it. Reads only, unless you opt in.
966
966
  farthershore code run -e '
@@ -971,10 +971,10 @@ farthershore code run -e '
971
971
 
972
972
  - **`code search <query...>`** — `--limit <n>` (default 20),
973
973
  `--side-effect read|write`, `--namespace <ns>`. Each hit shows the path
974
- (`fs.runtimeTokens.revoke`), a one-line summary and its flags (read/write,
974
+ (`fs.secretKeys.revoke`), a one-line summary and its flags (read/write,
975
975
  destructive, one-time secret, preview, paginated).
976
- - **`code describe <refs...>`** — accepts `runtimeTokens.revoke`,
977
- `fs.runtimeTokens.revoke`, the opKey `runtime_token.revoke`, or `docs:<page>` (1–25 refs).
976
+ - **`code describe <refs...>`** — accepts `secretKeys.revoke`,
977
+ `fs.secretKeys.revoke`, the opKey `secret_key.revoke`, or `docs:<page>` (1–25 refs).
978
978
  - **`code types [namespace]`** — a self-contained `.d.ts` for `fs`, generated
979
979
  from the same tables `code run` enforces, with JSDoc from the operation
980
980
  specs.
@@ -1092,7 +1092,11 @@ run in CI.
1092
1092
 
1093
1093
  MIT
1094
1094
 
1095
- Code discovery includes docs guides: `farthershore code search runtime token`.
1095
+ Managed webhook receivers are listed by backend slug and receiver address. A
1096
+ tunnel receiver shows `/_fs/webhooks`; a direct receiver shows its public HTTPS
1097
+ URL. Change a managed receiver's destination by connecting its backend.
1098
+
1099
+ Code discovery includes docs guides: `farthershore code search secret key`.
1096
1100
  Read one with `farthershore code describe docs:agents/overview`; describe accepts
1097
1101
  1–25 method paths, opKeys, or docs refs. Use `--no-guides` or `--namespace` to
1098
1102
  search methods only. Use `--stage` to select stage docs; production is the default.
@@ -1100,7 +1104,7 @@ For exact catalog filtering, use `farthershore code search --code 'return catalo
1100
1104
  or `--code-file script.js`. Filters have a frozen catalog and no platform access.
1101
1105
  Entries include `input` and `output` as TypeScript text (`input` is null for
1102
1106
  methods without arguments), and `required` lists top-level required field names.
1103
- `farthershore docs search "runtime token"` uses docs search and falls back to
1107
+ `farthershore docs search "secret key"` uses docs search and falls back to
1104
1108
  literal text when unavailable. `--literal` or `--collection` forces literal search.
1105
1109
 
1106
1110
  Rename a usage unit for display without changing reporting keys or balances:
@@ -1114,6 +1118,14 @@ The same operation is available to MCP as `fs.businesses.brand.update` with
1114
1118
  `body.usageUnitLabel: { unitKey: "credits:tokens", label: "Requests" }`.
1115
1119
  Use `label: null` to restore the default.
1116
1120
 
1121
+ ### Export your data
1122
+
1123
+ Run `farthershore account export --format json > personal-data.json` with your personal session to export your account data. Organization credentials cannot use this command.
1124
+
1125
+ Export a customer’s business-scoped data: `farthershore consumer export <businessIdOrSlug> <subscriberId> --format json`.
1126
+
1127
+ Check a request without changing customer data: `farthershore consumer erasure-status <businessIdOrSlug> <subscriberId> --format json`. A person must request erasure in the dashboard.
1128
+
1117
1129
  ## Staying up to date
1118
1130
 
1119
1131
  Global npm installs on macOS and Linux (including a custom npm `prefix` set