@farthershore/cli 0.45.0 → 0.47.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 +23 -1
- package/README.md +42 -17
- package/dist/index.js +633 -174
- package/package.json +4 -4
package/CHANGELOG.md
CHANGED
|
@@ -4,7 +4,29 @@ 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
|
-
## [
|
|
7
|
+
## [0.47.0] - 2026-11-21
|
|
8
|
+
|
|
9
|
+
### Added
|
|
10
|
+
|
|
11
|
+
- `farthershore validate` checks your frontend against what your business sells before a build refuses it: a paid plan needs a way to cancel, a metered product needs a usage view, and so on. It reads `frontend/src` on your machine and sends nothing anywhere. A gap is reported as `FRONTEND_DEPENDENCY_MISSING` with the page or control to add.
|
|
12
|
+
|
|
13
|
+
### Removed
|
|
14
|
+
|
|
15
|
+
- **Breaking:** Removed `business update --usage-unit-label` and `--clear-usage-unit-label`. A credit usage unit's customer-facing name is now declared in the business program: `fs.usageUnit.credits("tokens", { display: "Tokens" })`. Change it there and release.
|
|
16
|
+
|
|
17
|
+
## [0.46.0] - 2026-11-21
|
|
18
|
+
|
|
19
|
+
### Added
|
|
20
|
+
|
|
21
|
+
- `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.
|
|
22
|
+
- `farthershore business release-tag set <business> --prefix <prefix> | --clear`: choose the prefix of release tags (`v` by default).
|
|
23
|
+
|
|
24
|
+
### Changed
|
|
25
|
+
|
|
26
|
+
- `farthershore skills install` installs the Farther Shore skills bundle
|
|
27
|
+
v4.0.4. The backend skill now uses `FS_SECRET_KEY`, the default secret key
|
|
28
|
+
that serves every environment and `--for all` shared bindings, and adds
|
|
29
|
+
guidance on host tooling, infrastructure as code and preview databases.
|
|
8
30
|
|
|
9
31
|
## [0.45.0] - 2026-11-21
|
|
10
32
|
|
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.47.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.47.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.47.0 farthershore --help
|
|
30
30
|
```
|
|
31
31
|
|
|
32
32
|
## Authentication
|
|
@@ -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.
|
|
@@ -567,9 +597,11 @@ with placeholder data and auth bypassed.
|
|
|
567
597
|
A build is published only when its output ships the SDK's managed sign-in.
|
|
568
598
|
A refused build never replaces what is live; `frontend status` shows the
|
|
569
599
|
reason, and `builds[].diagnostics[].code` is `FRONTEND_SIGN_IN_MISSING` (mount
|
|
570
|
-
`<FartherShoreRoot>` and render `<FsSignIn />`)
|
|
571
|
-
(upgrade `@farthershore/farthershore-js`)
|
|
572
|
-
|
|
600
|
+
`<FartherShoreRoot>` and render `<FsSignIn />`), `FRONTEND_SDK_TOO_OLD`
|
|
601
|
+
(upgrade `@farthershore/farthershore-js`) or `FRONTEND_DEPENDENCY_MISSING`
|
|
602
|
+
(the frontend leaves out a piece your customers need: one entry per piece,
|
|
603
|
+
each with its fix; `farthershore validate` finds them before you push).
|
|
604
|
+
`--wait` exits `BUILD_FAILED` with that code in `details.reasonCode`. Mock mode is for this local preview only: a
|
|
573
605
|
hosted portal ignores it, and always uses the platform's sign-in.
|
|
574
606
|
|
|
575
607
|
```bash
|
|
@@ -859,7 +891,7 @@ farthershore skills install
|
|
|
859
891
|
```
|
|
860
892
|
|
|
861
893
|
If the platform-owned skills installer is unavailable, stop and ask the human to run
|
|
862
|
-
`npm install -g @farthershore/cli@0.
|
|
894
|
+
`npm install -g @farthershore/cli@0.47.0`, then repeat the installer help check.
|
|
863
895
|
The CLI keeps itself current (see Staying up to date); do not otherwise install
|
|
864
896
|
or upgrade global tooling autonomously.
|
|
865
897
|
|
|
@@ -1107,16 +1139,9 @@ methods without arguments), and `required` lists top-level required field names.
|
|
|
1107
1139
|
`farthershore docs search "secret key"` uses docs search and falls back to
|
|
1108
1140
|
literal text when unavailable. `--literal` or `--collection` forces literal search.
|
|
1109
1141
|
|
|
1110
|
-
|
|
1111
|
-
|
|
1112
|
-
|
|
1113
|
-
farthershore business update <business> --usage-unit-label "Requests"
|
|
1114
|
-
farthershore business update <business> --clear-usage-unit-label
|
|
1115
|
-
```
|
|
1116
|
-
|
|
1117
|
-
The same operation is available to MCP as `fs.businesses.brand.update` with
|
|
1118
|
-
`body.usageUnitLabel: { unitKey: "credits:tokens", label: "Requests" }`.
|
|
1119
|
-
Use `label: null` to restore the default.
|
|
1142
|
+
A credit usage unit's customer-facing name is declared in the business
|
|
1143
|
+
program, not set here: `fs.usageUnit.credits("tokens", { display: "Requests" })`.
|
|
1144
|
+
Change it and release; reporting keys and balances do not change.
|
|
1120
1145
|
|
|
1121
1146
|
### Export your data
|
|
1122
1147
|
|