@farthershore/cli 0.44.0 → 0.46.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 +39 -0
- package/README.md +53 -19
- package/dist/index.js +869 -285
- package/package.json +4 -4
package/CHANGELOG.md
CHANGED
|
@@ -4,6 +4,43 @@ All notable changes to the `farthershore` CLI are documented here. The CLI
|
|
|
4
4
|
versions independently from the SDKs. Pre-1.0: minor versions may include
|
|
5
5
|
breaking changes. Releases before 0.35.0 are recorded only in the git history.
|
|
6
6
|
|
|
7
|
+
## [0.46.0] - 2026-11-21
|
|
8
|
+
|
|
9
|
+
### Added
|
|
10
|
+
|
|
11
|
+
- `farthershore business release <business>`: release what is on the default branch of a live business. It picks major, minor or patch from what changed and cuts the release; `--dry-run` shows the plan, `--bump` / `--version X.Y.Z` override it, `--wait` follows it until it is live. In a terminal it asks before releasing and releases exactly the commit you confirmed.
|
|
12
|
+
- `farthershore business release-tag set <business> --prefix <prefix> | --clear`: choose the prefix of release tags (`v` by default).
|
|
13
|
+
|
|
14
|
+
### Changed
|
|
15
|
+
|
|
16
|
+
- `farthershore skills install` installs the Farther Shore skills bundle
|
|
17
|
+
v4.0.4. The backend skill now uses `FS_SECRET_KEY`, the default secret key
|
|
18
|
+
that serves every environment and `--for all` shared bindings, and adds
|
|
19
|
+
guidance on host tooling, infrastructure as code and preview databases.
|
|
20
|
+
|
|
21
|
+
## [0.45.0] - 2026-11-21
|
|
22
|
+
|
|
23
|
+
### Added — connect a backend with one key
|
|
24
|
+
|
|
25
|
+
- `backend bind` defaults to the business's default backend, returns its
|
|
26
|
+
receiver URL, and shows the default `FS_SECRET_KEY` once when issued.
|
|
27
|
+
- Backend deployments and keys support `--for` scope selection across
|
|
28
|
+
production and preview environments; token operations include
|
|
29
|
+
`webhook_secrets` for automatic webhook verification.
|
|
30
|
+
|
|
31
|
+
### Added
|
|
32
|
+
|
|
33
|
+
- `farthershore webhook redeliver <business> <webhookId> <deliveryId>` sends
|
|
34
|
+
one delivery again (same `webhook-id`).
|
|
35
|
+
- `farthershore webhook redeliver-failed <business> <webhookId> --since <time>
|
|
36
|
+
[--until <time>]` sends every failed or dead delivery in the window again.
|
|
37
|
+
Times are ISO-8601 or a span back from now (`30m`, `24h`, `7d`).
|
|
38
|
+
|
|
39
|
+
### Changed
|
|
40
|
+
|
|
41
|
+
- Webhook endpoint output carries `pausedAt` instead of `disabledAt`.
|
|
42
|
+
Requires the matching platform release.
|
|
43
|
+
|
|
7
44
|
## [0.44.0] - 2026-11-20
|
|
8
45
|
|
|
9
46
|
- Add `farthershore organization seller-details show`: the seller details every business in the organization shows its customers, read from the organization's Stripe account.
|
|
@@ -37,6 +74,8 @@ breaking changes. Releases before 0.35.0 are recorded only in the git history.
|
|
|
37
74
|
|
|
38
75
|
## [0.40.0] - 2026-11-06
|
|
39
76
|
|
|
77
|
+
- **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.
|
|
78
|
+
|
|
40
79
|
- **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.
|
|
41
80
|
|
|
42
81
|
### Added
|
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.
|
|
6
|
+
**Status: `0.46.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.
|
|
23
|
+
npm install -g @farthershore/cli@0.46.0
|
|
24
24
|
```
|
|
25
25
|
|
|
26
26
|
Or run it directly with npx:
|
|
27
27
|
|
|
28
28
|
```bash
|
|
29
|
-
npx -p @farthershore/cli@0.
|
|
29
|
+
npx -p @farthershore/cli@0.46.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 "
|
|
198
|
+
farthershore docs search "secret key" --collection sdks --limit 10 --format json
|
|
199
199
|
farthershore docs collection sdks --format json
|
|
200
200
|
```
|
|
201
201
|
|
|
@@ -358,6 +358,36 @@ farthershore business update weather-api \
|
|
|
358
358
|
|
|
359
359
|
`business publish` enforces the same go-live gates as the dashboard and returns
|
|
360
360
|
stable remediation errors when a prerequisite is missing.
|
|
361
|
+
|
|
362
|
+
`business publish` takes a draft business live with its first release. After
|
|
363
|
+
that, `business release` releases what is on the default branch: it compares
|
|
364
|
+
the branch with the last release that deployed, picks major, minor or patch,
|
|
365
|
+
runs the same go-live checks against the contract being released, and cuts the
|
|
366
|
+
release at that exact commit. In a terminal it shows the commit, version and
|
|
367
|
+
reasons and asks first; `--no-input` skips the question.
|
|
368
|
+
|
|
369
|
+
```bash
|
|
370
|
+
farthershore business release weather-api --dry-run --format json
|
|
371
|
+
farthershore business release weather-api --wait --format json
|
|
372
|
+
farthershore business release weather-api --version 2.0.0 --accept-breaking --no-input
|
|
373
|
+
```
|
|
374
|
+
|
|
375
|
+
`--dry-run` shows the plan and cuts nothing. `--wait` follows the release, and
|
|
376
|
+
the release commit's frontend build when `frontend/` changed, until it is live
|
|
377
|
+
(`--timeout`, default 900 seconds). `--bump major|minor|patch` or
|
|
378
|
+
`--version X.Y.Z` (above the current release) override the version; pass one,
|
|
379
|
+
not both. It refuses with `NOTHING_TO_RELEASE` when nothing changed since the
|
|
380
|
+
last deployed release, and `RELEASE_SOURCE_NOT_READY` while the latest change
|
|
381
|
+
under `business/` is still being checked.
|
|
382
|
+
|
|
383
|
+
Release tags are `<prefix>X.Y.Z`, `v` by default. Changing the prefix continues
|
|
384
|
+
the version numbers and never renames existing tags:
|
|
385
|
+
|
|
386
|
+
```bash
|
|
387
|
+
farthershore business release-tag set weather-api --prefix release- --format json
|
|
388
|
+
farthershore business release-tag set weather-api --clear --format json
|
|
389
|
+
```
|
|
390
|
+
|
|
361
391
|
Recover a Business contract by correcting or reverting its program in Git,
|
|
362
392
|
validating it in preview, and publishing a new release. Use `business status`
|
|
363
393
|
and Apply Timeline to verify the expected release is serving.
|
|
@@ -713,9 +743,9 @@ cannot use the inherited secret.
|
|
|
713
743
|
|
|
714
744
|
### `farthershore backend`
|
|
715
745
|
|
|
716
|
-
Create bring-your-own backends and provision
|
|
746
|
+
Create bring-your-own backends and provision secret keys for your upstream
|
|
717
747
|
services. Only token hashes are stored; the raw token is returned once and should
|
|
718
|
-
be deployed as `
|
|
748
|
+
be deployed as `FS_SECRET_KEY`.
|
|
719
749
|
|
|
720
750
|
```bash
|
|
721
751
|
farthershore backend list weather-api --format json
|
|
@@ -725,11 +755,11 @@ farthershore backend create weather-api \
|
|
|
725
755
|
--format json
|
|
726
756
|
farthershore backend bind weather-api api \
|
|
727
757
|
--env preview-42 \
|
|
728
|
-
--origin
|
|
758
|
+
--origin https://api-pr-42.example.com \
|
|
729
759
|
--format json
|
|
730
|
-
farthershore backend
|
|
731
|
-
farthershore backend
|
|
732
|
-
farthershore backend
|
|
760
|
+
farthershore backend keys create weather-api --backend <backendId> --format json
|
|
761
|
+
farthershore backend keys rotate weather-api <tokenId> --yes --format json
|
|
762
|
+
farthershore backend keys revoke weather-api <tokenId> --yes --format json
|
|
733
763
|
```
|
|
734
764
|
|
|
735
765
|
Pair the token with
|
|
@@ -859,7 +889,7 @@ farthershore skills install
|
|
|
859
889
|
```
|
|
860
890
|
|
|
861
891
|
If the platform-owned skills installer is unavailable, stop and ask the human to run
|
|
862
|
-
`npm install -g @farthershore/cli@0.
|
|
892
|
+
`npm install -g @farthershore/cli@0.46.0`, then repeat the installer help check.
|
|
863
893
|
The CLI keeps itself current (see Staying up to date); do not otherwise install
|
|
864
894
|
or upgrade global tooling autonomously.
|
|
865
895
|
|
|
@@ -953,14 +983,14 @@ back — the intermediate data never has to pass through a transcript.
|
|
|
953
983
|
|
|
954
984
|
```bash
|
|
955
985
|
# 1. Find operations (ranked by name, path, summary and description).
|
|
956
|
-
farthershore code search
|
|
986
|
+
farthershore code search secret key --format json
|
|
957
987
|
|
|
958
988
|
# 2. Read one: description, TypeScript signature, safety flags, reconcile
|
|
959
989
|
# read, required permission and a runnable example.
|
|
960
|
-
farthershore code describe
|
|
990
|
+
farthershore code describe secretKeys.revoke
|
|
961
991
|
|
|
962
992
|
# 3. Load the types you need (or the whole API) before writing the script.
|
|
963
|
-
farthershore code types
|
|
993
|
+
farthershore code types secretKeys > fs.d.ts
|
|
964
994
|
|
|
965
995
|
# 4. Run it. Reads only, unless you opt in.
|
|
966
996
|
farthershore code run -e '
|
|
@@ -971,10 +1001,10 @@ farthershore code run -e '
|
|
|
971
1001
|
|
|
972
1002
|
- **`code search <query...>`** — `--limit <n>` (default 20),
|
|
973
1003
|
`--side-effect read|write`, `--namespace <ns>`. Each hit shows the path
|
|
974
|
-
(`fs.
|
|
1004
|
+
(`fs.secretKeys.revoke`), a one-line summary and its flags (read/write,
|
|
975
1005
|
destructive, one-time secret, preview, paginated).
|
|
976
|
-
- **`code describe <refs...>`** — accepts `
|
|
977
|
-
`fs.
|
|
1006
|
+
- **`code describe <refs...>`** — accepts `secretKeys.revoke`,
|
|
1007
|
+
`fs.secretKeys.revoke`, the opKey `secret_key.revoke`, or `docs:<page>` (1–25 refs).
|
|
978
1008
|
- **`code types [namespace]`** — a self-contained `.d.ts` for `fs`, generated
|
|
979
1009
|
from the same tables `code run` enforces, with JSDoc from the operation
|
|
980
1010
|
specs.
|
|
@@ -1092,7 +1122,11 @@ run in CI.
|
|
|
1092
1122
|
|
|
1093
1123
|
MIT
|
|
1094
1124
|
|
|
1095
|
-
|
|
1125
|
+
Managed webhook receivers are listed by backend slug and receiver address. A
|
|
1126
|
+
tunnel receiver shows `/_fs/webhooks`; a direct receiver shows its public HTTPS
|
|
1127
|
+
URL. Change a managed receiver's destination by connecting its backend.
|
|
1128
|
+
|
|
1129
|
+
Code discovery includes docs guides: `farthershore code search secret key`.
|
|
1096
1130
|
Read one with `farthershore code describe docs:agents/overview`; describe accepts
|
|
1097
1131
|
1–25 method paths, opKeys, or docs refs. Use `--no-guides` or `--namespace` to
|
|
1098
1132
|
search methods only. Use `--stage` to select stage docs; production is the default.
|
|
@@ -1100,7 +1134,7 @@ For exact catalog filtering, use `farthershore code search --code 'return catalo
|
|
|
1100
1134
|
or `--code-file script.js`. Filters have a frozen catalog and no platform access.
|
|
1101
1135
|
Entries include `input` and `output` as TypeScript text (`input` is null for
|
|
1102
1136
|
methods without arguments), and `required` lists top-level required field names.
|
|
1103
|
-
`farthershore docs search "
|
|
1137
|
+
`farthershore docs search "secret key"` uses docs search and falls back to
|
|
1104
1138
|
literal text when unavailable. `--literal` or `--collection` forces literal search.
|
|
1105
1139
|
|
|
1106
1140
|
Rename a usage unit for display without changing reporting keys or balances:
|