@farthershore/cli 0.24.2 → 0.24.3

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.
Files changed (3) hide show
  1. package/README.md +30 -8
  2. package/dist/index.js +90 -76
  3. package/package.json +2 -2
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.24.2`.** Pre-1.0 — the command surface is stable but may still
6
+ **Status: `0.24.3`.** 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,
@@ -80,7 +80,7 @@ cd weather-api
80
80
  # ...edit business/business.ts with @farthershore/business...
81
81
 
82
82
  # 3. Validate the same way the PR check will, before pushing
83
- farthershore preflight --business weather-api
83
+ farthershore validate --business weather-api
84
84
 
85
85
  # 4. Push — the GitHub bot compiles + applies your manifest
86
86
  git push --set-upstream origin feature/pricing
@@ -155,6 +155,23 @@ specific shape; omitting it keeps the default `frontend + api` starter. Run
155
155
  `npm install` in `business/`, then `farthershore build` from the repo root to
156
156
  confirm it compiles.
157
157
 
158
+ ### `farthershore create`
159
+
160
+ Create local project components inside a managed builder repo. `create api`
161
+ scaffolds a starter backend into `api/` by downloading the public Node template
162
+ tarball, then patches the repo root `.gitignore`.
163
+
164
+ ```bash
165
+ farthershore create api
166
+ farthershore create api --path ../weather-api
167
+ farthershore create api --force
168
+ farthershore create api --node --ref v0.1.0 --format json
169
+ ```
170
+
171
+ `--node` is the default language today: Node (TypeScript + Express). `--ref`
172
+ accepts a template tag or branch name, trying tags first. More languages are
173
+ planned.
174
+
158
175
  ### `farthershore build`
159
176
 
160
177
  Compile `business/business.ts` to a Manifest IR envelope locally (default
@@ -168,7 +185,7 @@ farthershore build --entry business/business.ts --out business-build.json
168
185
  farthershore build --format json
169
186
  ```
170
187
 
171
- ### `farthershore preflight`
188
+ ### `farthershore validate`
172
189
 
173
190
  Run the same verdict the GitHub `farthershore/validate` PR check produces, before
174
191
  you push. It builds the manifest twice and compares the IR hash (the determinism
@@ -177,9 +194,9 @@ IR for a server dry-run that returns compile diagnostics, the semantic diff, and
177
194
  an economic-change verdict.
178
195
 
179
196
  ```bash
180
- farthershore preflight # local build + determinism only
181
- farthershore preflight --business weather-api # + full server verdict
182
- farthershore preflight --local-only --format json
197
+ farthershore validate # local build + determinism only
198
+ farthershore validate --business weather-api # + full server verdict
199
+ farthershore validate --local-only --format json
183
200
  ```
184
201
 
185
202
  ### `farthershore business`
@@ -280,7 +297,9 @@ farthershore plan migrate weather-api pro --from 1 --to head --policy next_renew
280
297
  Managed Frontend Hosting operations plus a local preview. `deploy`, `status`,
281
298
  `rollback`, and `env` operate the hosted build; `preview` runs the generated
282
299
  `frontend/`'s `vite dev` with an injected `window.__FS_CONFIG__` shim so the
283
- portal renders locally exactly as it serves in production.
300
+ portal renders locally exactly as it serves in production. Pass `--mock` to
301
+ inject `{ mock: true }` instead of Core/Clerk config for local page inspection
302
+ with placeholder data and auth bypassed.
284
303
 
285
304
  ```bash
286
305
  farthershore frontend status weather-api --format json
@@ -290,6 +309,9 @@ farthershore frontend env list weather-api --format json
290
309
  farthershore frontend env set weather-api VITE_PUBLIC_FOO bar --target BUILD --format json
291
310
 
292
311
  # Local preview (shells out to vite; needs a frontend/ project)
312
+ farthershore frontend dev # hot-reloading dev server, mock mode by default
313
+ farthershore frontend preview # production build served as-is, mock mode by default
314
+ farthershore frontend dev --live # against the real platform
293
315
  farthershore frontend preview --core-url http://localhost:8787
294
316
  ```
295
317
 
@@ -508,7 +530,7 @@ without parsing text:
508
530
  The CLI is non-interactive whenever a token is available via `--token` or
509
531
  `FARTHERSHORE_TOKEN` — `auth login` only prompts when stdin is a TTY and no token
510
532
  was passed, so it is safe to script. `farthershore build` and `farthershore
511
- preflight --local-only` need no network or auth and are safe to run in CI.
533
+ validate --local-only` need no network or auth and are safe to run in CI.
512
534
 
513
535
  ## MCP server
514
536