@forumulate/cli 0.19.1 → 0.20.1
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/dist/cache-command.d.ts +1 -1
- package/dist/cache-command.d.ts.map +1 -1
- package/dist/doctor/command.d.ts +1 -1
- package/dist/doctor/command.d.ts.map +1 -1
- package/dist/doctor/org-report.d.ts +1 -1
- package/dist/doctor/org-report.d.ts.map +1 -1
- package/dist/doctor/org-report.js +40 -1
- package/dist/doctor/org-report.js.map +1 -1
- package/dist/exit-codes.d.ts +1 -1
- package/dist/exit-codes.d.ts.map +1 -1
- package/dist/exit-codes.js +1 -0
- package/dist/exit-codes.js.map +1 -1
- package/dist/help-commands.d.ts +11 -11
- package/dist/help-commands.d.ts.map +1 -1
- package/dist/help-commands.js +16 -1
- package/dist/help-commands.js.map +1 -1
- package/dist/help.d.ts +1 -1
- package/dist/help.d.ts.map +1 -1
- package/dist/help.js +9 -0
- package/dist/help.js.map +1 -1
- package/dist/import/mdx.d.ts +40 -0
- package/dist/import/mdx.d.ts.map +1 -0
- package/dist/import/mdx.js +154 -0
- package/dist/import/mdx.js.map +1 -0
- package/dist/known-flags.d.ts +9 -0
- package/dist/known-flags.d.ts.map +1 -0
- package/dist/known-flags.js +49 -0
- package/dist/known-flags.js.map +1 -0
- package/dist/plan/command.d.ts +6 -0
- package/dist/plan/command.d.ts.map +1 -1
- package/dist/plan/command.js +30 -3
- package/dist/plan/command.js.map +1 -1
- package/dist/plan/document.d.ts.map +1 -1
- package/dist/plan/document.js +10 -0
- package/dist/plan/document.js.map +1 -1
- package/dist/plan/markdown-dir.d.ts +5 -0
- package/dist/plan/markdown-dir.d.ts.map +1 -1
- package/dist/plan/markdown-dir.js +11 -4
- package/dist/plan/markdown-dir.js.map +1 -1
- package/dist/plan/output.d.ts +8 -0
- package/dist/plan/output.d.ts.map +1 -1
- package/dist/plan/output.js +22 -1
- package/dist/plan/output.js.map +1 -1
- package/dist/plan/posts-files.js +1 -1
- package/dist/plan/posts-files.js.map +1 -1
- package/dist/plan/pull.d.ts +17 -0
- package/dist/plan/pull.d.ts.map +1 -0
- package/dist/plan/pull.js +133 -0
- package/dist/plan/pull.js.map +1 -0
- package/dist/plan/records.d.ts +24 -0
- package/dist/plan/records.d.ts.map +1 -0
- package/dist/plan/records.js +39 -0
- package/dist/plan/records.js.map +1 -0
- package/dist/plan/secrets.d.ts +6 -0
- package/dist/plan/secrets.d.ts.map +1 -0
- package/dist/plan/secrets.js +75 -0
- package/dist/plan/secrets.js.map +1 -0
- package/dist/publish/command.d.ts +2 -0
- package/dist/publish/command.d.ts.map +1 -1
- package/dist/publish/command.js +13 -0
- package/dist/publish/command.js.map +1 -1
- package/dist/publish/docs-plan.d.ts.map +1 -1
- package/dist/publish/docs-plan.js +10 -1
- package/dist/publish/docs-plan.js.map +1 -1
- package/dist/publish/rewrite.d.ts.map +1 -1
- package/dist/publish/rewrite.js +8 -0
- package/dist/publish/rewrite.js.map +1 -1
- package/dist/publish/scan-docs.js +1 -0
- package/dist/publish/scan-docs.js.map +1 -1
- package/dist/publish/types.d.ts +2 -0
- package/dist/publish/types.d.ts.map +1 -1
- package/dist/publish-command.d.ts +2 -0
- package/dist/publish-command.d.ts.map +1 -1
- package/dist/publish-command.js +6 -0
- package/dist/publish-command.js.map +1 -1
- package/dist/run.d.ts.map +1 -1
- package/dist/run.js +43 -5
- package/dist/run.js.map +1 -1
- package/dist/validate.d.ts +1 -1
- package/dist/validate.d.ts.map +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/dist/whoami.d.ts +1 -1
- package/dist/whoami.d.ts.map +1 -1
- package/package.json +1 -1
package/dist/cache-command.d.ts
CHANGED
|
@@ -7,6 +7,6 @@ import { type CommandDeps } from './commands/context';
|
|
|
7
7
|
* now has one verb for the flush, calling the `Cache_*` operations; deleting
|
|
8
8
|
* for good is `spaces destroy` / `items destroy` and asks for the slug.
|
|
9
9
|
*/
|
|
10
|
-
export declare const CACHE_HELP = "forumulate cache \u2014 drop cached copies of published pages\n\nUsage:\n forumulate cache purge --space <id|slug> [--page <id|slug>] [--org <id|slug>] [--json]\n forumulate cache purge --org <id|slug> --all-spaces [--json]\n\n Drops cached copies \u2014 our web tier and every CDN the org has configured\n (Cloudflare, Fastly, Bunny, KeyCDN, or a purge webhook) \u2014 and prints which\n addresses went and which CDN took them (`edge: none` when no CDN fronts them).\n NOTHING IS DELETED: content, drafts and history are untouched. To delete a\n trashed page or space for good, see `forumulate items destroy` /\n `forumulate spaces destroy`.\n\n --page one page (its slug and id addresses on every domain)\n --space the whole space: every page, locale variant and old address\n --all-spaces every space in the org (with --org)\n\nExamples:\n forumulate cache purge --space docs\n forumulate cache purge --space docs --page getting-started --json\n\nExit status:\n 0 ok 1 failed (verification mismatch, doctor FAIL)\n 2 usage 3 auth (no token, 401, token not allowed)\n 4 not found 5 conflict (409/412, edited in the studio since your last publish)\n 124 --wait timed out (the job keeps running; with --wait, a failed job is 1)";
|
|
10
|
+
export declare const CACHE_HELP = "forumulate cache \u2014 drop cached copies of published pages\n\nUsage:\n forumulate cache purge --space <id|slug> [--page <id|slug>] [--org <id|slug>] [--json]\n forumulate cache purge --org <id|slug> --all-spaces [--json]\n\n Drops cached copies \u2014 our web tier and every CDN the org has configured\n (Cloudflare, Fastly, Bunny, KeyCDN, or a purge webhook) \u2014 and prints which\n addresses went and which CDN took them (`edge: none` when no CDN fronts them).\n NOTHING IS DELETED: content, drafts and history are untouched. To delete a\n trashed page or space for good, see `forumulate items destroy` /\n `forumulate spaces destroy`.\n\n --page one page (its slug and id addresses on every domain)\n --space the whole space: every page, locale variant and old address\n --all-spaces every space in the org (with --org)\n\nExamples:\n forumulate cache purge --space docs\n forumulate cache purge --space docs --page getting-started --json\n\nExit status:\n 0 ok 1 failed (verification mismatch, doctor FAIL)\n 2 usage 3 auth (no token, 401, token not allowed)\n 4 not found 5 conflict (409/412, edited in the studio since your last publish)\n 9 not ours: Node refuses a missing --env-file before the CLI starts (use --vars-file)\n 124 --wait timed out (the job keeps running; with --wait, a failed job is 1)";
|
|
11
11
|
export declare function runCache(argv: string[], deps: CommandDeps): Promise<number>;
|
|
12
12
|
//# sourceMappingURL=cache-command.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cache-command.d.ts","sourceRoot":"","sources":["../src/cache-command.ts"],"names":[],"mappings":"AAEA,OAAO,EAAwB,KAAK,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAG5E;;;;;;;GAOG;AACH,eAAO,MAAM,UAAU,
|
|
1
|
+
{"version":3,"file":"cache-command.d.ts","sourceRoot":"","sources":["../src/cache-command.ts"],"names":[],"mappings":"AAEA,OAAO,EAAwB,KAAK,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAG5E;;;;;;;GAOG;AACH,eAAO,MAAM,UAAU,s2CAqBJ,CAAC;AAWpB,wBAAsB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,CA2CjF"}
|
package/dist/doctor/command.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Http } from '../api/http';
|
|
2
2
|
import { type DoctorReport } from '../doctor';
|
|
3
3
|
export declare const DOCTOR_CHECK_IDS: readonly string[];
|
|
4
|
-
export declare const DOCTOR_HELP = "forumulate doctor \u2014 check a live site from the outside\n\nUsage:\n forumulate doctor <readerUrl> [flags]\n forumulate doctor --site <slug|id> [--org <slug|id>] [flags]\n forumulate doctor --org <slug|id> [--json]\n\n--org alone (no URL, no --site) is one report of the organization's own wiring: reader\nsign-in warnings, the consent and executor links, heartbeat staleness, and whether each\ncustom address is served (the API's integration-health board plus reader-auth warnings;\nneeds a token with org.manage_integrations and org.manage_settings).\n\nPlain HTTP, no token needed for a URL: the same report against our platform, a\nstaging mount or any other docs host. --site asks the API for every address of\nevery space on a site (needs a token), and checks each copy.\n\nFlags:\n --site <slug|id> every member space, at its custom domain AND its\n platform copy (token: FORUMULATE_TOKEN or `login`)\n --org <slug|id> the org --site is in (default: FORUMULATE_ORG / config)\n --also <url> another address of the same page, e.g. the platform copy\n of a custom-domain page (repeatable)\n --only a,b run just these checks (ids below)\n --json the full report as JSON on stdout (nothing else there)\n --api-base <origin> where /api/health lives, when not on the page's host\n --platform-host <h> the hosting platform's hostname, for white-label and\n canonical checks (default: FORUMULATE_URL's host, else\n forumulate.com)\n --limit <n> sitemap URLs to sample (default 60)\n --timeout <ms> per-request timeout (default 15000)\n\nChecks (id \u2014 what fails it):\n health /api/health not 2xx JSON (also tried under the mount)\n public-read a logged-out reader is sent to sign-in\n canonical the page's canonical names another host\n html-untouched a proxy rewrites the markup (email obfuscation)\n cache-headers no Cache-Control, or no-store, on the page\n robots / sitemap robots.txt missing, disallows the path, no Sitemap:\n crawler-access a crawler gets a different status than a reader\n feeds an advertised feed does not answer 200\n images a picture on the page does not load\n canonical-both-addresses a page's copies (custom domain, platform) name\n different canonicals, or not the primary address\n sitemap-crawl a sitemap URL redirects, 404s, is on another host or\n names another canonical\n cache-consistency pages of one space cached differently (public vs\n private/no-store) with no x-forumulate-cache-reason\n root-redirect a space root answers 302/307, or a redirect with a\n body over 1 KB, or lands on a page canonical elsewhere\n meta-description missing description/og:description, template text\n (\"Guides and reference, in a nested tree.\"), or\n headings run together\n llms-txt /llms.txt missing, no H1, preset summary, links on\n another host, slugs in titles, no sections/descriptions\n favicon /favicon.ico or <link rel=icon> not an image; an\n asset path answering a large HTML page\n consent-tag a consent manager (any CMP: Cookie Munch, Cookiebot,\n OneTrust, Osano, Termly, Usercentrics, Didomi,\n iubenda, Complianz, TCF) not told the page language\n white-label-leaks a custom-domain page or its .md twin links to the\n platform host\n robots-params (advice) prints the Disallow lines that keep crawlers\n off each mount's ?sort= / ?period= / ?range= copies\n reader-auth-atlas (advice, needs --org and a token) the organization\n uses Atlas but signs readers in another way (an\n external_jwt route): prints the relink and the switch\n to the Atlas reader provider (readerAuth: atlas)\n\nExamples:\n forumulate doctor https://docs.acme.com/docs\n forumulate doctor https://acme.com/legal/privacy --also https://forumulate.com/p/acme/legal/privacy\n forumulate doctor --site main --org acme --json > doctor.json\n forumulate doctor https://acme.com/docs --only sitemap-crawl,root-redirect\n\nIn CI: packages/cli/examples/github-action-doctor.yml runs this on a schedule and\non every push, uploads the JSON report and fails the job on any FAIL.\n\nExit status:\n 0 ok 1 failed (verification mismatch, doctor FAIL)\n 2 usage 3 auth (no token, 401, token not allowed)\n 4 not found 5 conflict (409/412, edited in the studio since your last publish)\n 124 --wait timed out (the job keeps running; with --wait, a failed job is 1)\n doctor: 1 when any check FAILs; a SKIP is not a failure.";
|
|
4
|
+
export declare const DOCTOR_HELP = "forumulate doctor \u2014 check a live site from the outside\n\nUsage:\n forumulate doctor <readerUrl> [flags]\n forumulate doctor --site <slug|id> [--org <slug|id>] [flags]\n forumulate doctor --org <slug|id> [--json]\n\n--org alone (no URL, no --site) is one report of the organization's own wiring: reader\nsign-in warnings, the consent and executor links, heartbeat staleness, and whether each\ncustom address is served (the API's integration-health board plus reader-auth warnings;\nneeds a token with org.manage_integrations and org.manage_settings).\n\nPlain HTTP, no token needed for a URL: the same report against our platform, a\nstaging mount or any other docs host. --site asks the API for every address of\nevery space on a site (needs a token), and checks each copy.\n\nFlags:\n --site <slug|id> every member space, at its custom domain AND its\n platform copy (token: FORUMULATE_TOKEN or `login`)\n --org <slug|id> the org --site is in (default: FORUMULATE_ORG / config)\n --also <url> another address of the same page, e.g. the platform copy\n of a custom-domain page (repeatable)\n --only a,b run just these checks (ids below)\n --json the full report as JSON on stdout (nothing else there)\n --api-base <origin> where /api/health lives, when not on the page's host\n --platform-host <h> the hosting platform's hostname, for white-label and\n canonical checks (default: FORUMULATE_URL's host, else\n forumulate.com)\n --limit <n> sitemap URLs to sample (default 60)\n --timeout <ms> per-request timeout (default 15000)\n\nChecks (id \u2014 what fails it):\n health /api/health not 2xx JSON (also tried under the mount)\n public-read a logged-out reader is sent to sign-in\n canonical the page's canonical names another host\n html-untouched a proxy rewrites the markup (email obfuscation)\n cache-headers no Cache-Control, or no-store, on the page\n robots / sitemap robots.txt missing, disallows the path, no Sitemap:\n crawler-access a crawler gets a different status than a reader\n feeds an advertised feed does not answer 200\n images a picture on the page does not load\n canonical-both-addresses a page's copies (custom domain, platform) name\n different canonicals, or not the primary address\n sitemap-crawl a sitemap URL redirects, 404s, is on another host or\n names another canonical\n cache-consistency pages of one space cached differently (public vs\n private/no-store) with no x-forumulate-cache-reason\n root-redirect a space root answers 302/307, or a redirect with a\n body over 1 KB, or lands on a page canonical elsewhere\n meta-description missing description/og:description, template text\n (\"Guides and reference, in a nested tree.\"), or\n headings run together\n llms-txt /llms.txt missing, no H1, preset summary, links on\n another host, slugs in titles, no sections/descriptions\n favicon /favicon.ico or <link rel=icon> not an image; an\n asset path answering a large HTML page\n consent-tag a consent manager (any CMP: Cookie Munch, Cookiebot,\n OneTrust, Osano, Termly, Usercentrics, Didomi,\n iubenda, Complianz, TCF) not told the page language\n white-label-leaks a custom-domain page or its .md twin links to the\n platform host\n robots-params (advice) prints the Disallow lines that keep crawlers\n off each mount's ?sort= / ?period= / ?range= copies\n reader-auth-atlas (advice, needs --org and a token) the organization\n uses Atlas but signs readers in another way (an\n external_jwt route): prints the relink and the switch\n to the Atlas reader provider (readerAuth: atlas)\n\nExamples:\n forumulate doctor https://docs.acme.com/docs\n forumulate doctor https://acme.com/legal/privacy --also https://forumulate.com/p/acme/legal/privacy\n forumulate doctor --site main --org acme --json > doctor.json\n forumulate doctor https://acme.com/docs --only sitemap-crawl,root-redirect\n\nIn CI: packages/cli/examples/github-action-doctor.yml runs this on a schedule and\non every push, uploads the JSON report and fails the job on any FAIL.\n\nExit status:\n 0 ok 1 failed (verification mismatch, doctor FAIL)\n 2 usage 3 auth (no token, 401, token not allowed)\n 4 not found 5 conflict (409/412, edited in the studio since your last publish)\n 9 not ours: Node refuses a missing --env-file before the CLI starts (use --vars-file)\n 124 --wait timed out (the job keeps running; with --wait, a failed job is 1)\n doctor: 1 when any check FAILs; a SKIP is not a failure.";
|
|
5
5
|
export interface DoctorCommandDeps {
|
|
6
6
|
out: (line: string) => void;
|
|
7
7
|
err: (line: string) => void;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"command.d.ts","sourceRoot":"","sources":["../../src/doctor/command.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAKnC,OAAO,EAA6B,KAAK,YAAY,EAAE,MAAM,WAAW,CAAC;AAQzE,eAAO,MAAM,gBAAgB,EAAE,SAAS,MAAM,EAI7C,CAAC;AAEF,eAAO,MAAM,WAAW,
|
|
1
|
+
{"version":3,"file":"command.d.ts","sourceRoot":"","sources":["../../src/doctor/command.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAKnC,OAAO,EAA6B,KAAK,YAAY,EAAE,MAAM,WAAW,CAAC;AAQzE,eAAO,MAAM,gBAAgB,EAAE,SAAS,MAAM,EAI7C,CAAC;AAEF,eAAO,MAAM,WAAW,0qKA8EmC,CAAC;AAE5D,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAC5B,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAC5B,GAAG,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC;IACxB,SAAS,CAAC,EAAE,OAAO,KAAK,CAAC;IACzB,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,qFAAqF;IACrF,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAID,4CAA4C;AAC5C,wBAAsB,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,MAAM,CAAC,CA8I/F;AAED,wBAAgB,WAAW,CAAC,MAAM,EAAE,YAAY,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI,CAUhF"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
import type { Check } from '../conformance';
|
|
2
2
|
import type { Http } from '../api/http';
|
|
3
|
-
export declare function orgReportChecks(http: Http, org: string): Promise<Check[]>;
|
|
3
|
+
export declare function orgReportChecks(http: Http, org: string, fetchImpl?: typeof fetch): Promise<Check[]>;
|
|
4
4
|
//# sourceMappingURL=org-report.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"org-report.d.ts","sourceRoot":"","sources":["../../src/doctor/org-report.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAgCxC,wBAAsB,eAAe,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,
|
|
1
|
+
{"version":3,"file":"org-report.d.ts","sourceRoot":"","sources":["../../src/doctor/org-report.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAgCxC,wBAAsB,eAAe,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,SAAS,GAAE,OAAO,KAAa,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,CA0DhH"}
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.orgReportChecks = orgReportChecks;
|
|
4
4
|
const probe_1 = require("./probe");
|
|
5
|
-
async function orgReportChecks(http, org) {
|
|
5
|
+
async function orgReportChecks(http, org, fetchImpl = fetch) {
|
|
6
6
|
const base = `/orgs/${encodeURIComponent(org)}`;
|
|
7
7
|
const out = [];
|
|
8
8
|
try {
|
|
@@ -32,6 +32,45 @@ async function orgReportChecks(http, org) {
|
|
|
32
32
|
const err = e;
|
|
33
33
|
out.push((0, probe_1.check)('reader-auth.warnings', 'reader sign-in has no warnings', 'skip', `Could not read the reader sign-in (${err.status ?? 'error'}): it needs a token with org.manage_settings.`));
|
|
34
34
|
}
|
|
35
|
+
out.push(...(await redirectChecks(http, base, fetchImpl)));
|
|
35
36
|
return out;
|
|
36
37
|
}
|
|
38
|
+
/**
|
|
39
|
+
* Each exact redirect rule, followed from a space's live address to its end: a rule
|
|
40
|
+
* can be right when written and dead after the page it names moves. Wildcards have no
|
|
41
|
+
* one URL to follow, and a space with no live address of its own has nothing to fetch.
|
|
42
|
+
*/
|
|
43
|
+
async function redirectChecks(http, base, fetchImpl) {
|
|
44
|
+
const id = 'redirects.targets';
|
|
45
|
+
const title = 'redirect rules end on a page';
|
|
46
|
+
const get = async (path) => (await http.send({ method: 'GET', path })).data;
|
|
47
|
+
try {
|
|
48
|
+
const { spaces } = await get(`${base}/spaces?limit=200`);
|
|
49
|
+
const dead = [];
|
|
50
|
+
let followed = 0;
|
|
51
|
+
for (const s of spaces ?? []) {
|
|
52
|
+
const { redirects } = await get(`${base}/spaces/${s.id}/redirects`);
|
|
53
|
+
const rules = (redirects ?? []).filter((r) => !r.auto && r.type !== 'rewrite' && !r.from.endsWith('*'));
|
|
54
|
+
if (!rules.length)
|
|
55
|
+
continue;
|
|
56
|
+
const { domains } = await get(`${base}/spaces/${s.id}/domains`);
|
|
57
|
+
const live = (domains ?? []).find((d) => d.active && !d.redirectTo);
|
|
58
|
+
if (!live)
|
|
59
|
+
continue;
|
|
60
|
+
for (const r of rules.slice(0, 200 - followed)) {
|
|
61
|
+
followed += 1;
|
|
62
|
+
const url = `https://${live.hostname}${(live.basePath ?? '').replace(/\/+$/, '')}${r.from}`;
|
|
63
|
+
const res = await fetchImpl(url, { redirect: 'follow', signal: AbortSignal.timeout(15_000) }).catch(() => null);
|
|
64
|
+
if (res?.status !== 200)
|
|
65
|
+
dead.push(`${url} -> ${res ? `${res.status} at ${res.url}` : 'no answer'}`);
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
if (dead.length)
|
|
69
|
+
return [(0, probe_1.check)(id, title, 'fail', dead.join('\n'), 'A redirect that ends on anything but a 200 strands the address it was there to keep.')];
|
|
70
|
+
return [followed ? (0, probe_1.check)(id, title, 'pass', `Followed ${followed} rule(s) to a 200.`) : (0, probe_1.check)(id, title, 'skip', 'No exact rule on a space with a live address.')];
|
|
71
|
+
}
|
|
72
|
+
catch (e) {
|
|
73
|
+
return [(0, probe_1.check)(id, title, 'skip', `Could not read the redirects (${e.status ?? 'error'}).`)];
|
|
74
|
+
}
|
|
75
|
+
}
|
|
37
76
|
//# sourceMappingURL=org-report.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"org-report.js","sourceRoot":"","sources":["../../src/doctor/org-report.ts"],"names":[],"mappings":";;AAiCA,
|
|
1
|
+
{"version":3,"file":"org-report.js","sourceRoot":"","sources":["../../src/doctor/org-report.ts"],"names":[],"mappings":";;AAiCA,0CA0DC;AAzFD,mCAAgC;AA+BzB,KAAK,UAAU,eAAe,CAAC,IAAU,EAAE,GAAW,EAAE,YAA0B,KAAK;IAC5F,MAAM,IAAI,GAAG,SAAS,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC;IAChD,MAAM,GAAG,GAAY,EAAE,CAAC;IAExB,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,IAAI,qBAAqB,EAAE,CAAC,CAAC,CAAC,IAErF,CAAC;QACF,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,MAAM,IAAI,EAAE,EAAE,CAAC;YAClC,mFAAmF;YACnF,MAAM,KAAK,GAAmB,CAAC,CAAC,EAAE,KAAK,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,IAAI,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC;YACrG,MAAM,MAAM,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,KAAK,KAAK,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,KAAK,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;iBACjH,MAAM,CAAC,OAAO,CAAC;iBACf,IAAI,CAAC,IAAI,CAAC,CAAC;YACd,GAAG,CAAC,IAAI,CAAC,IAAA,aAAK,EAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC,EAAE,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAClF,CAAC;IACH,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,GAAG,GAAG,CAAwB,CAAC;QACrC,GAAG,CAAC,IAAI,CACN,IAAA,aAAK,EACH,oBAAoB,EACpB,oBAAoB,EACpB,MAAM,EACN,yCAAyC,GAAG,CAAC,MAAM,IAAI,OAAO,mDAAmD,CAClH,CACF,CAAC;IACJ,CAAC;IAED,6FAA6F;IAC7F,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,IAAI,cAAc,EAAE,CAAC,CAAC,CAAC,IAE9E,CAAC;QACF,MAAM,QAAQ,GAAG,CAAC,IAAI,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAqB,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACnH,GAAG,CAAC,IAAI,CACN,QAAQ,CAAC,MAAM;YACb,CAAC,CAAC,IAAA,aAAK,EACH,sBAAsB,EACtB,gCAAgC,EAChC,MAAM,EACN,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EACrF,qGAAqG,CACtG;YACH,CAAC,CAAC,IAAA,aAAK,EAAC,sBAAsB,EAAE,gCAAgC,EAAE,MAAM,EAAE,0CAA0C,CAAC,CACxH,CAAC;IACJ,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,GAAG,GAAG,CAAwB,CAAC;QACrC,GAAG,CAAC,IAAI,CACN,IAAA,aAAK,EACH,sBAAsB,EACtB,gCAAgC,EAChC,MAAM,EACN,sCAAsC,GAAG,CAAC,MAAM,IAAI,OAAO,+CAA+C,CAC3G,CACF,CAAC;IACJ,CAAC;IACD,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;IAC3D,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,cAAc,CAAC,IAAU,EAAE,IAAY,EAAE,SAAuB;IAC7E,MAAM,EAAE,GAAG,mBAAmB,CAAC;IAC/B,MAAM,KAAK,GAAG,8BAA8B,CAAC;IAC7C,MAAM,GAAG,GAAG,KAAK,EAAK,IAAY,EAAE,EAAE,CAAC,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,IAAS,CAAC;IAC5F,IAAI,CAAC;QACH,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,CAA8C,GAAG,IAAI,mBAAmB,CAAC,CAAC;QACtG,MAAM,IAAI,GAAa,EAAE,CAAC;QAC1B,IAAI,QAAQ,GAAG,CAAC,CAAC;QACjB,KAAK,MAAM,CAAC,IAAI,MAAM,IAAI,EAAE,EAAE,CAAC;YAC7B,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,GAAG,CAAoE,GAAG,IAAI,WAAW,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;YACvI,MAAM,KAAK,GAAG,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,IAAI,KAAK,SAAS,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;YACxG,IAAI,CAAC,KAAK,CAAC,MAAM;gBAAE,SAAS;YAC5B,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,GAAG,CAAwG,GAAG,IAAI,WAAW,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC;YACvK,MAAM,IAAI,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;YACpE,IAAI,CAAC,IAAI;gBAAE,SAAS;YACpB,KAAK,MAAM,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,GAAG,QAAQ,CAAC,EAAE,CAAC;gBAC/C,QAAQ,IAAI,CAAC,CAAC;gBACd,MAAM,GAAG,GAAG,WAAW,IAAI,CAAC,QAAQ,GAAG,CAAC,IAAI,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;gBAC5F,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,GAAG,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;gBAChH,IAAI,GAAG,EAAE,MAAM,KAAK,GAAG;oBAAE,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,OAAO,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,MAAM,OAAO,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;YACvG,CAAC;QACH,CAAC;QACD,IAAI,IAAI,CAAC,MAAM;YAAE,OAAO,CAAC,IAAA,aAAK,EAAC,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,sFAAsF,CAAC,CAAC,CAAC;QAC5J,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAA,aAAK,EAAC,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,QAAQ,oBAAoB,CAAC,CAAC,CAAC,CAAC,IAAA,aAAK,EAAC,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,+CAA+C,CAAC,CAAC,CAAC;IACrK,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO,CAAC,IAAA,aAAK,EAAC,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,iCAAkC,CAAyB,CAAC,MAAM,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC;IACvH,CAAC;AACH,CAAC"}
|
package/dist/exit-codes.d.ts
CHANGED
|
@@ -27,7 +27,7 @@ export declare const EXIT: {
|
|
|
27
27
|
};
|
|
28
28
|
export type ExitCode = (typeof EXIT)[keyof typeof EXIT];
|
|
29
29
|
/** The block `--help` prints, so every command documents the same table. */
|
|
30
|
-
export declare const EXIT_CODES_HELP = "Exit status:\n 0 ok 1 failed (verification mismatch, doctor FAIL)\n 2 usage 3 auth (no token, 401, token not allowed)\n 4 not found 5 conflict (409/412, edited in the studio since your last publish)\n 124 --wait timed out (the job keeps running; with --wait, a failed job is 1)";
|
|
30
|
+
export declare const EXIT_CODES_HELP = "Exit status:\n 0 ok 1 failed (verification mismatch, doctor FAIL)\n 2 usage 3 auth (no token, 401, token not allowed)\n 4 not found 5 conflict (409/412, edited in the studio since your last publish)\n 9 not ours: Node refuses a missing --env-file before the CLI starts (use --vars-file)\n 124 --wait timed out (the job keeps running; with --wait, a failed job is 1)";
|
|
31
31
|
/**
|
|
32
32
|
* The exit code an API error maps to.
|
|
33
33
|
*
|
package/dist/exit-codes.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"exit-codes.d.ts","sourceRoot":"","sources":["../src/exit-codes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,eAAO,MAAM,IAAI;IACf,qDAAqD;;IAErD,iGAAiG;;IAEjG,gGAAgG;;IAEhG,8FAA8F;;IAE9F,oEAAoE;;IAEpE,+FAA+F;;IAE/F,0GAA0G;;CAElG,CAAC;AAEX,MAAM,MAAM,QAAQ,GAAG,CAAC,OAAO,IAAI,CAAC,CAAC,MAAM,OAAO,IAAI,CAAC,CAAC;AAExD,4EAA4E;AAC5E,eAAO,MAAM,eAAe,
|
|
1
|
+
{"version":3,"file":"exit-codes.d.ts","sourceRoot":"","sources":["../src/exit-codes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,eAAO,MAAM,IAAI;IACf,qDAAqD;;IAErD,iGAAiG;;IAEjG,gGAAgG;;IAEhG,8FAA8F;;IAE9F,oEAAoE;;IAEpE,+FAA+F;;IAE/F,0GAA0G;;CAElG,CAAC;AAEX,MAAM,MAAM,QAAQ,GAAG,CAAC,OAAO,IAAI,CAAC,CAAC,MAAM,OAAO,IAAI,CAAC,CAAC;AAExD,4EAA4E;AAC5E,eAAO,MAAM,eAAe,+YAKmD,CAAC;AAEhF;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,OAAO,GAAG,QAAQ,CAarD"}
|
package/dist/exit-codes.js
CHANGED
|
@@ -34,6 +34,7 @@ exports.EXIT_CODES_HELP = `Exit status:
|
|
|
34
34
|
0 ok 1 failed (verification mismatch, doctor FAIL)
|
|
35
35
|
2 usage 3 auth (no token, 401, token not allowed)
|
|
36
36
|
4 not found 5 conflict (409/412, edited in the studio since your last publish)
|
|
37
|
+
9 not ours: Node refuses a missing --env-file before the CLI starts (use --vars-file)
|
|
37
38
|
124 --wait timed out (the job keeps running; with --wait, a failed job is 1)`;
|
|
38
39
|
/**
|
|
39
40
|
* The exit code an API error maps to.
|
package/dist/exit-codes.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"exit-codes.js","sourceRoot":"","sources":["../src/exit-codes.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"exit-codes.js","sourceRoot":"","sources":["../src/exit-codes.ts"],"names":[],"mappings":";;;AA8CA,4CAaC;AA3DD;;;;;;;;;;GAUG;AACU,QAAA,IAAI,GAAG;IAClB,qDAAqD;IACrD,EAAE,EAAE,CAAC;IACL,iGAAiG;IACjG,MAAM,EAAE,CAAC;IACT,gGAAgG;IAChG,KAAK,EAAE,CAAC;IACR,8FAA8F;IAC9F,IAAI,EAAE,CAAC;IACP,oEAAoE;IACpE,SAAS,EAAE,CAAC;IACZ,+FAA+F;IAC/F,QAAQ,EAAE,CAAC;IACX,0GAA0G;IAC1G,OAAO,EAAE,GAAG;CACJ,CAAC;AAIX,4EAA4E;AAC/D,QAAA,eAAe,GAAG;;;;;+EAKgD,CAAC;AAEhF;;;;;;;GAOG;AACH,SAAgB,gBAAgB,CAAC,CAAU;IACzC,MAAM,GAAG,GAAG,CAAiE,CAAC;IAC9E,IAAI,GAAG,IAAI,OAAO,GAAG,CAAC,QAAQ,KAAK,QAAQ;QAAE,OAAO,GAAG,CAAC,QAAoB,CAAC;IAC7E,8EAA8E;IAC9E,yEAAyE;IACzE,gFAAgF;IAChF,IAAI,GAAG,EAAE,IAAI,KAAK,cAAc;QAAE,OAAO,YAAI,CAAC,MAAM,CAAC;IACrD,MAAM,MAAM,GAAG,GAAG,EAAE,MAAM,CAAC;IAC3B,IAAI,MAAM,KAAK,GAAG,IAAI,MAAM,KAAK,GAAG;QAAE,OAAO,YAAI,CAAC,IAAI,CAAC;IACvD,IAAI,MAAM,KAAK,GAAG,IAAI,MAAM,KAAK,GAAG;QAAE,OAAO,YAAI,CAAC,SAAS,CAAC;IAC5D,IAAI,MAAM,KAAK,GAAG,IAAI,MAAM,KAAK,GAAG;QAAE,OAAO,YAAI,CAAC,QAAQ,CAAC;IAC3D,IAAI,MAAM,KAAK,GAAG,IAAI,MAAM,KAAK,GAAG;QAAE,OAAO,YAAI,CAAC,KAAK,CAAC;IACxD,OAAO,YAAI,CAAC,MAAM,CAAC;AACrB,CAAC"}
|
package/dist/help-commands.d.ts
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
|
-
export declare const PUBLISH_HELP = "forumulate publish \u2014 publish a folder of Markdown into a space\n\nUsage:\n forumulate publish <folder> --org <id|slug> --space <id|slug> [flags]\n\n (org: and space: may come from forumulate.yaml, FORUMULATE_ORG / FORUMULATE_SPACE\n or `forumulate config set` instead of the flags.)\n\n One folder per collection, front matter for titles, slugs, order and SEO, assets\n uploaded once by content hash. A re-run changes only what changed, then reads the\n space back and fails if anything did not land.\n\nFlags:\n --dry-run print the plan; write nothing (no token needed for a public space)\n --prune move pages/posts/collections with no file to the trash\n --only a,b just these slugs, files, folders, or manifest parts\n (site, theme, settings, openapi, monitors)\n --force re-send every page even if it looks unchanged, AND overwrite pages\n edited in the studio since the last publish\n --purge page|space|none\n what to drop from the cache when done (default page): page = every\n page this run changed; space = the whole space (a title in the\n navigation changed); none = leave the CDN alone. Reported per CDN.\n --no-verify skip the read-back --pace <ms> gap between writes (250)\n --manifest <file> a forumulate.yaml somewhere else\n --diff print the changed paragraphs and fields of each update\n --strict fail (exit 1, nothing written) on a relative link that names no page;\n without it each one is printed as `warn <file>:<line> link to nothing`\n --no-report do not record this run (publish.completed is not sent)\n --json one JSON summary: {space, created, updated, unchanged, trashed,\n purged, verify, diffUrl, runId, lines, errors}\n --out <file> write that output to a file\n --preview <name> publish nothing: send the pages this run would add or change (and\n with --prune, remove) to a preview named <name> (pr-123) and print\n its link \u2014 the space as the change would publish it, on its own\n addresses, for 7 days (previews.ttl_days). Same name again: same\n link, renewed. --json adds previews[{urls, summary, comment}].\n --preview-ttl <d> a shorter life for the preview link, in days\n --comment with --preview in CI: post the link and diff table on the pull\n request (GitHub, Gitea, GitLab, Bitbucket; GITHUB_TOKEN /\n GITEA_TOKEN / GITLAB_TOKEN / BITBUCKET_TOKEN), editing it on re-runs\n\nLinks: a relative link to a page in ANOTHER space of this folder (../guides/x.md, or\n./x when only one other space has x) is rewritten to that page's address on the host\nboth spaces are published on; one that names no page anywhere is reported, here and\nby the importer (unresolvedLinks).\n\nStudio edits: a page edited in the studio (or through the API) since this folder was\nlast published is not overwritten. The run stops before writing and prints\n CONFLICT <slug> edited in studio by <name> at <time>\nPull the change into the file, or re-run with --force to overwrite it.\n\nforumulate.yaml keys:\n org, space where to publish (one space), or\n spaces: [{path, space, create: {type, name, visibility}, rootCollection,\n theme, settings, tags, openapi: [{file|url, collection, ...}], monitors,\n redirects: [{from, to, status?, type?}] or a CSV file name,\n redirects are merged into the space's table, never replaced\n about: {...} | about.yaml (an ABOUT space's parts)}]\n site: {...} the site configuration (applied with PATCH semantics)\n theme: {...} the space theme\n Guide: https://forumulate.com/guides/content-as-code\n\nOlder forms (deprecated in 0.11.0; they still run and print a notice on stderr):\n publish <orgId> <spaceId> <folder> \u2192 publish <folder> --org \u2026 --space \u2026\n publish <orgId> <spaceId> <pageId> \u2192 forumulate items publish <pageId> --space \u2026\n\nExamples:\n forumulate publish docs --org acme --space docs --dry-run\n forumulate publish docs --org acme --space docs --purge space --json --out run.json\n forumulate publish docs --org acme --space docs --preview pr-123 --comment\n\nOutput (every command):\n --json the result as JSON on stdout; progress and warnings go to stderr\n --out <file> write stdout to a file instead (never truncated, exit 1 if the write fails)\n\nExit status:\n 0 ok 1 failed (verification mismatch, doctor FAIL)\n 2 usage 3 auth (no token, 401, token not allowed)\n 4 not found 5 conflict (409/412, edited in the studio since your last publish)\n 124 --wait timed out (the job keeps running; with --wait, a failed job is 1)";
|
|
2
|
-
export declare const SYNC_HELP = "forumulate sync \u2014 the same folder publish, plan by default\n\nUsage:\n forumulate sync <folder> [--apply] [--prune] [--diff] [--org \u2026] [--space \u2026]\n\n Without --apply it plans and writes nothing; with --apply it is `publish`.\n Takes every publish flag (--only, --force, --purge, --no-verify, --pace,\n --manifest, --json). See `forumulate publish --help` for them and the\n forumulate.yaml keys.\n\nOutput (every command):\n --json the result as JSON on stdout; progress and warnings go to stderr\n --out <file> write stdout to a file instead (never truncated, exit 1 if the write fails)\n\nExit status:\n 0 ok 1 failed (verification mismatch, doctor FAIL)\n 2 usage 3 auth (no token, 401, token not allowed)\n 4 not found 5 conflict (409/412, edited in the studio since your last publish)\n 124 --wait timed out (the job keeps running; with --wait, a failed job is 1)";
|
|
3
|
-
export declare const PLAN_HELP = "forumulate plan / forumulate apply \u2014 one document for a whole site\n\nUsage:\n forumulate plan [forumulate.yaml] [--org <id|slug>] [--create-org] [--diff] [--check] [--prune] [--verbose]\n forumulate apply [forumulate.yaml] [--org <id|slug>] [--create-org] [--prune] [--batch <n>] [--secrets-file <path>] [--verbose]\n\n Reads a version-2 forumulate.yaml and the Markdown folders it names, and sends it to\n PUT /orgs/{org}/manifest: plan is the dry run (the diff, nothing written), apply\n writes it. Every unit goes through the endpoint that owns it, is read back after the\n write, and is recorded, so a re-apply of the same files writes nothing and a page\n edited in the studio since the last apply shows as drift.\n\nFlags:\n --org <o> the organization (else `org:` in the file, else FORUMULATE_ORG)\n --create-org the org may not exist yet (same as `orgName:` in the file): plan prints\n `+ create org <slug>` and plans the rest against an empty org, writing nothing;\n apply creates it first (`orgs ensure`), then applies\n --diff plan: print each changed field, from -> to\n --check plan: exit 1 when anything would change (drift detection in CI)\n --prune also delete what this manifest created earlier and no longer\n declares \u2014 only for the kinds the file declares (pages go to the trash)\n --batch <n> apply: changed pages per request (default 20; the edge cuts a request at 30 s)\n --allow-unset-env apply: publish a page whose ${NAME} is unset as written (default: refuse)\n --secrets-file <p> apply: write every shown-once value (executor key, webhook secret) and every\n heartbeat's pingUrl (monitors/<space>/<name>, on every apply) to <p> as JSON,\n mode 0600, merged over what it holds (an existing file must already be 0600).\n Without it they are redacted in the output, human and --json alike: keep the file\n --verbose list unchanged steps and what exists but the file does not mention\n (left alone; --json always carries it as `extras`)\n --json the API's answer (plan) or {ok, batches} (apply)\n\n ${NAME} is read from the environment anywhere outside pages/posts: a whole value, or\n inside a string (url: ${API_URL}/health); $${NAME} is the literal text. In content and\n code keys (body, customJs, \u2026) only a whole value. An unset name stops the run.\n The organization must exist, unless the file says `orgName:` or you pass --create-org;\n `forumulate orgs ensure <slug>` also creates it (idempotent).\n A domain whose `state` waits on a verification file not served yet is held (onUnverified: hold,\n the default): plan and apply print `waiting: \u2026` with what each proof method saw, every other\n unit applies, and apply still exits 0 \u2014 re-apply once the file is served.\n apply puts each heartbeat monitor's pingUrl in --secrets-file; `forumulate heartbeat ping-url` re-reads it.\n\nforumulate.yaml (version: 2):\n version: 2\n org: acme\n spaces: [{slug, name, type, visibility, settings, theme, redirects, collections,\n locales: [{code, label}], seo: {...}, translations: {<code>: {name,\n description, seoTitle, seoDescription}}, preset, piecePreset, frontDoor,\n contactForm: {...} | file.yaml (CONTACT), about: {...} | file.yaml (ABOUT)}]\n pages: [{dir: content/docs, space: docs, collection?, locales?, ignore?: [globs],\n env?: true (substitute ${NAME} in bodies)} a Markdown folder:\n page.md + page.es.md or es/page.md twins; front matter title, slug,\n seoTitle, seoDescription, canonicalUrl, sections, collection, order\n (or a 01- prefix), draft; sub-folders are collections\n | {space, slug, title, body, ...}] or one page inline\n sites: [{slug, name, spaces: [slugs], config: {...}, configMode: merge|replace}]\n domains, reader_auth, consent, connectors, executor, webhooks, tokens, status_monitors,\n brand, prune \u2014 as PUT /orgs/{org}/manifest documents them.\n Guide: https://forumulate.com/guides/forumulate-yaml-apply\n\nExamples:\n forumulate plan --diff\n forumulate plan --check # CI: fail when the site drifted from the repository\n forumulate apply --prune\n\nOutput (every command):\n --json the result as JSON on stdout; progress and warnings go to stderr\n --out <file> write stdout to a file instead (never truncated, exit 1 if the write fails)\n\nExit status:\n 0 ok 1 failed (verification mismatch, doctor FAIL)\n 2 usage 3 auth (no token, 401, token not allowed)\n 4 not found 5 conflict (409/412, edited in the studio since your last publish)\n 124 --wait timed out (the job keeps running; with --wait, a failed job is 1)";
|
|
4
|
-
export declare const DEV_HELP = "forumulate dev \u2014 preview a folder of Markdown locally\n\nUsage:\n forumulate dev <folder> --org <id|slug> --space <id|slug> [--port 4321] [--site <url>]\n\n Renders with your space's own renderer and reloads on save. Nothing is written\n to the space.\n\nExit status:\n 0 ok 1 failed (verification mismatch, doctor FAIL)\n 2 usage 3 auth (no token, 401, token not allowed)\n 4 not found 5 conflict (409/412, edited in the studio since your last publish)\n 124 --wait timed out (the job keeps running; with --wait, a failed job is 1)";
|
|
5
|
-
export declare const LOGIN_HELP = "forumulate login \u2014 store a token for this API\n\nUsage:\n forumulate login [--token <pat>] (asks for it, hidden, when not given)\n\n The token is checked against the API first, then stored in\n ~/.config/forumulate/credentials.json (mode 0600), keyed by API base, so a\n staging token is never sent to production. On every later command a\n --token beats FORUMULATE_TOKEN, which beats the stored token.\n Mint a token at https://forumulate.com/account/tokens\n\nExit status:\n 0 ok 1 failed (verification mismatch, doctor FAIL)\n 2 usage 3 auth (no token, 401, token not allowed)\n 4 not found 5 conflict (409/412, edited in the studio since your last publish)\n 124 --wait timed out (the job keeps running; with --wait, a failed job is 1)";
|
|
6
|
-
export declare const LOGOUT_HELP = "forumulate logout \u2014 forget the stored token for this API\n\nUsage:\n forumulate logout\n\n Warns when FORUMULATE_TOKEN is still set, because it still wins.\n\nExit status:\n 0 ok 1 failed (verification mismatch, doctor FAIL)\n 2 usage 3 auth (no token, 401, token not allowed)\n 4 not found 5 conflict (409/412, edited in the studio since your last publish)\n 124 --wait timed out (the job keeps running; with --wait, a failed job is 1)";
|
|
7
|
-
export declare const SNAPSHOT_HELP = "forumulate snapshot \u2014 save a version snapshot of a space\n\nUsage:\n forumulate snapshot <orgId> <spaceId> <label\u2026> [--json]\n (also: forumulate snapshots --help)\n\nExit status:\n 0 ok 1 failed (verification mismatch, doctor FAIL)\n 2 usage 3 auth (no token, 401, token not allowed)\n 4 not found 5 conflict (409/412, edited in the studio since your last publish)\n 124 --wait timed out (the job keeps running; with --wait, a failed job is 1)";
|
|
8
|
-
export declare const CONFORMANCE_HELP = "forumulate conformance \u2014 run the Content Sync Protocol suite\n\nUsage:\n forumulate conformance <collectionUrl> [--json]\n\n Runs against any platform's collection endpoint, ours included. Exit 1 when a\n check fails.\n\nExit status:\n 0 ok 1 failed (verification mismatch, doctor FAIL)\n 2 usage 3 auth (no token, 401, token not allowed)\n 4 not found 5 conflict (409/412, edited in the studio since your last publish)\n 124 --wait timed out (the job keeps running; with --wait, a failed job is 1)";
|
|
9
|
-
export declare const CONTENT_HELP = "forumulate content \u2014 a content library's model as code\n\nUsage:\n forumulate content types --library <id|slug> [--org \u2026] [--out forumulate.d.ts]\n [--preview] [--schema <file>] [--check]\n forumulate content pull --library <id|slug> [--format json|payload] [--out <file>]\n forumulate content push [file] [--library \u2026] [--dry-run] [--yes] [--force]\n [--rename type.field=new | block:hero.field=new | library:field=new]\n [--rename-type old=new] [--rename-block old=new]\n\n Here --out names the file the command writes (not a stdout redirect).\n\nExit status:\n 0 ok 1 failed (verification mismatch, doctor FAIL)\n 2 usage 3 auth (no token, 401, token not allowed)\n 4 not found 5 conflict (409/412, edited in the studio since your last publish)\n 124 --wait timed out (the job keeps running; with --wait, a failed job is 1)";
|
|
10
|
-
export declare const IMPORT_HELP = "forumulate import \u2014 bring another CMS's content into a library\n\nUsage:\n forumulate import <payload|contentful|sanity|strapi|wordpress> <export path>\n --library <id|slug> [--org \u2026] [--dry-run] [--yes]\n [--config payload.config.ts] [--publish source|all|none]\n [--allow-model-removals] [--pace <ms>] [--base-url <url>]\n\n Always shows a dry run first; a re-run updates what a previous import made.\n\nOutput (every command):\n --json the result as JSON on stdout; progress and warnings go to stderr\n --out <file> write stdout to a file instead (never truncated, exit 1 if the write fails)\n\nExit status:\n 0 ok 1 failed (verification mismatch, doctor FAIL)\n 2 usage 3 auth (no token, 401, token not allowed)\n 4 not found 5 conflict (409/412, edited in the studio since your last publish)\n 124 --wait timed out (the job keeps running; with --wait, a failed job is 1)";
|
|
11
|
-
export declare const TRANSLATIONS_HELP = "forumulate translations (alias i18n) \u2014 every translation capability\n\nUsage:\n forumulate translations locales list|add|relabel|remove|set [--space \u2026|--library \u2026]\n forumulate translations status [--locale es,fr] [--fail-on missing,outdated]\n forumulate translations pull [--out translations] [--locale \u2026] [--only \u2026]\n forumulate translations push [dir] [--dry-run]\n forumulate translations auto --locale es [--state missing,outdated] [--publish]\n forumulate translations labels|overrides pull|push [file] [--format json|xliff]\n forumulate translations item-locale <itemId> <locale|none>\n forumulate translations remove <pieceId> <locale> --yes\n forumulate translations entry <entryId> <locale> [--fields f.json]\n forumulate translations name <locale> <name\u2026>\n forumulate translations switcher get|set <f.json>\n forumulate translations provider status|connect|disconnect\n\n Here --out names the folder or file the command writes.\n\nExit status:\n 0 ok 1 failed (verification mismatch, doctor FAIL)\n 2 usage 3 auth (no token, 401, token not allowed)\n 4 not found 5 conflict (409/412, edited in the studio since your last publish)\n 124 --wait timed out (the job keeps running; with --wait, a failed job is 1)";
|
|
1
|
+
export declare const PUBLISH_HELP = "forumulate publish \u2014 publish a folder of Markdown into a space\n\nUsage:\n forumulate publish <folder> --org <id|slug> --space <id|slug> [flags]\n\n (org: and space: may come from forumulate.yaml, FORUMULATE_ORG / FORUMULATE_SPACE\n or `forumulate config set` instead of the flags.)\n\n One folder per collection, front matter for titles, slugs, order and SEO, assets\n uploaded once by content hash. A re-run changes only what changed, then reads the\n space back and fails if anything did not land.\n\nFlags:\n --dry-run print the plan; write nothing (no token needed for a public space)\n --prune move pages/posts/collections with no file to the trash\n --only a,b just these slugs, files, folders, or manifest parts\n (site, theme, settings, openapi, monitors)\n --force re-send every page even if it looks unchanged, AND overwrite pages\n edited in the studio since the last publish\n --purge page|space|none\n what to drop from the cache when done (default page): page = every\n page this run changed; space = the whole space (a title in the\n navigation changed); none = leave the CDN alone. Reported per CDN.\n --no-verify skip the read-back --pace <ms> gap between writes (250)\n --manifest <file> a forumulate.yaml somewhere else\n --diff print the changed paragraphs and fields of each update\n --strict fail (exit 1, nothing written) on a relative link that names no page;\n without it each one is printed as `warn <file>:<line> link to nothing`\n --no-report do not record this run (publish.completed is not sent)\n --json one JSON summary: {space, created, updated, unchanged, trashed,\n purged, verify, diffUrl, runId, lines, errors}\n --out <file> write that output to a file\n --preview <name> publish nothing: send the pages this run would add or change (and\n with --prune, remove) to a preview named <name> (pr-123) and print\n its link \u2014 the space as the change would publish it, on its own\n addresses, for 7 days (previews.ttl_days). Same name again: same\n link, renewed. --json adds previews[{urls, summary, comment}].\n --preview-ttl <d> a shorter life for the preview link, in days\n --comment with --preview in CI: post the link and diff table on the pull\n request (GitHub, Gitea, GitLab, Bitbucket; GITHUB_TOKEN /\n GITEA_TOKEN / GITLAB_TOKEN / BITBUCKET_TOKEN), editing it on re-runs\n\nLinks: a relative link to a page in ANOTHER space of this folder (../guides/x.md, or\n./x when only one other space has x) is rewritten to that page's address on the host\nboth spaces are published on; one that names no page anywhere is reported, here and\nby the importer (unresolvedLinks).\n\nStudio edits: a page edited in the studio (or through the API) since this folder was\nlast published is not overwritten. The run stops before writing and prints\n CONFLICT <slug> edited in studio by <name> at <time>\nPull the change into the file, or re-run with --force to overwrite it.\n\nforumulate.yaml keys:\n org, space where to publish (one space), or\n spaces: [{path, space, create: {type, name, visibility}, rootCollection,\n theme, settings, tags, openapi: [{file|url, collection, ...}], monitors,\n redirects: [{from, to, status?, type?}] or a CSV file name,\n redirects are merged into the space's table, never replaced\n about: {...} | about.yaml (an ABOUT space's parts)}]\n site: {...} the site configuration (applied with PATCH semantics)\n theme: {...} the space theme\n Guide: https://forumulate.com/guides/content-as-code\n\nOlder forms (deprecated in 0.11.0; they still run and print a notice on stderr):\n publish <orgId> <spaceId> <folder> \u2192 publish <folder> --org \u2026 --space \u2026\n publish <orgId> <spaceId> <pageId> \u2192 forumulate items publish <pageId> --space \u2026\n\nExamples:\n forumulate publish docs --org acme --space docs --dry-run\n forumulate publish docs --org acme --space docs --purge space --json --out run.json\n forumulate publish docs --org acme --space docs --preview pr-123 --comment\n\nOutput (every command):\n --json the result as JSON on stdout; progress and warnings go to stderr\n --out <file> write stdout to a file instead (never truncated, exit 1 if the write fails)\n\nExit status:\n 0 ok 1 failed (verification mismatch, doctor FAIL)\n 2 usage 3 auth (no token, 401, token not allowed)\n 4 not found 5 conflict (409/412, edited in the studio since your last publish)\n 9 not ours: Node refuses a missing --env-file before the CLI starts (use --vars-file)\n 124 --wait timed out (the job keeps running; with --wait, a failed job is 1)";
|
|
2
|
+
export declare const SYNC_HELP = "forumulate sync \u2014 the same folder publish, plan by default\n\nUsage:\n forumulate sync <folder> [--apply] [--prune] [--diff] [--org \u2026] [--space \u2026]\n\n Without --apply it plans and writes nothing; with --apply it is `publish`.\n Takes every publish flag (--only, --force, --purge, --no-verify, --pace,\n --manifest, --json). See `forumulate publish --help` for them and the\n forumulate.yaml keys.\n\nOutput (every command):\n --json the result as JSON on stdout; progress and warnings go to stderr\n --out <file> write stdout to a file instead (never truncated, exit 1 if the write fails)\n\nExit status:\n 0 ok 1 failed (verification mismatch, doctor FAIL)\n 2 usage 3 auth (no token, 401, token not allowed)\n 4 not found 5 conflict (409/412, edited in the studio since your last publish)\n 9 not ours: Node refuses a missing --env-file before the CLI starts (use --vars-file)\n 124 --wait timed out (the job keeps running; with --wait, a failed job is 1)";
|
|
3
|
+
export declare const PLAN_HELP = "forumulate plan / forumulate apply \u2014 one document for a whole site\n\nUsage:\n forumulate plan [forumulate.yaml] [--org <id|slug>] [--create-org] [--diff] [--check] [--prune] [--verbose]\n forumulate apply [forumulate.yaml] [--org <id|slug>] [--create-org] [--prune] [--batch <n>] [--secrets-file <path>] [--verbose]\n\n Reads a version-2 forumulate.yaml and the Markdown folders it names, and sends it to\n PUT /orgs/{org}/manifest: plan is the dry run (the diff, nothing written), apply\n writes it. Every unit goes through the endpoint that owns it, is read back after the\n write, and is recorded, so a re-apply of the same files writes nothing and a page\n edited in the studio since the last apply shows as drift.\n\nFlags:\n --org <o> the organization (else `org:` in the file, else FORUMULATE_ORG)\n --create-org the org may not exist yet (same as `orgName:` in the file): plan prints\n `+ create org <slug>` and plans the rest against an empty org, writing nothing;\n apply creates it first (`orgs ensure`), then applies\n --diff plan: print each changed field, from -> to\n --check plan: exit 1 when anything would change (drift detection in CI)\n --prune also delete what this manifest created earlier and no longer\n declares \u2014 only for the kinds the file declares (pages go to the trash)\n --batch <n> apply: changed pages per request (default 20; the edge cuts a request at 30 s)\n --vars-file <p> read ${NAME}s from a dotenv file, repeatable (later files win); values of 8+ characters\n are masked in all output (--show-secrets reveals them); --env-file is the old name, and\n for a missing file there Node itself exits 9 before the CLI starts; a variable already set in the shell wins\n --show-secrets leave declared secrets in the output; refused unless stdout is a terminal\n --allow-unset-env apply: publish a page whose ${NAME} is unset as written (default: refuse)\n --secrets-file <p> apply: write every shown-once value (executor key, webhook secret) and every\n heartbeat's pingUrl (monitors/<space>/<name>, on every apply) to <p> as JSON,\n mode 0600, merged over what it holds (an existing file must already be 0600).\n Without it they are redacted in the output, human and --json alike: keep the file\n --verbose list unchanged steps and what exists but the file does not mention\n (left alone; --json always carries it as `extras`)\n --json the API's answer (plan) or {ok, batches} (apply)\n\n ${NAME} is read from the environment anywhere outside pages/posts: a whole value, or\n inside a string (url: ${API_URL}/health); $${NAME} is the literal text. In content and\n code keys (body, customJs, \u2026) only a whole value. An unset name stops the run.\n The organization must exist, unless the file says `orgName:` or you pass --create-org;\n `forumulate orgs ensure <slug>` also creates it (idempotent).\n A domain whose `state` waits on a verification file not served yet is held (onUnverified: hold,\n the default): plan and apply print `waiting: \u2026` with what each proof method saw, every other\n unit applies, and apply still exits 0 \u2014 re-apply once the file is served.\n apply puts each heartbeat monitor's pingUrl in --secrets-file; `forumulate heartbeat ping-url` re-reads it.\n\nforumulate.yaml (version: 2):\n version: 2\n org: acme\n spaces: [{slug, name, type, visibility, settings, theme, redirects, collections,\n locales: [{code, label}], seo: {...}, translations: {<code>: {name,\n description, seoTitle, seoDescription}}, preset, piecePreset, frontDoor,\n contactForm: {...} | file.yaml (CONTACT), about: {...} | file.yaml (ABOUT)}]\n pages: [{dir: content/docs, space: docs, collection?, locales?, ignore?: [globs],\n env?: true (substitute ${NAME} in bodies)} a Markdown folder:\n page.md + page.es.md or es/page.md twins; front matter title, slug,\n seoTitle, seoDescription, canonicalUrl, sections, collection, order\n (or a 01- prefix), draft; sub-folders are collections\n | {space, slug, title, body, ...}] or one page inline\n sites: [{slug, name, spaces: [slugs], config: {...}, configMode: merge|replace}]\n domains, reader_auth, consent, connectors, executor, webhooks, tokens, status_monitors,\n brand, prune \u2014 as PUT /orgs/{org}/manifest documents them.\n Guide: https://forumulate.com/guides/forumulate-yaml-apply\n\nExamples:\n forumulate plan --diff\n forumulate plan --check # CI: fail when the site drifted from the repository\n forumulate apply --prune\n\nOutput (every command):\n --json the result as JSON on stdout; progress and warnings go to stderr\n --out <file> write stdout to a file instead (never truncated, exit 1 if the write fails)\n\nExit status:\n 0 ok 1 failed (verification mismatch, doctor FAIL)\n 2 usage 3 auth (no token, 401, token not allowed)\n 4 not found 5 conflict (409/412, edited in the studio since your last publish)\n 9 not ours: Node refuses a missing --env-file before the CLI starts (use --vars-file)\n 124 --wait timed out (the job keeps running; with --wait, a failed job is 1)";
|
|
4
|
+
export declare const DEV_HELP = "forumulate dev \u2014 preview a folder of Markdown locally\n\nUsage:\n forumulate dev <folder> --org <id|slug> --space <id|slug> [--port 4321] [--site <url>]\n\n Renders with your space's own renderer and reloads on save. Nothing is written\n to the space.\n\nExit status:\n 0 ok 1 failed (verification mismatch, doctor FAIL)\n 2 usage 3 auth (no token, 401, token not allowed)\n 4 not found 5 conflict (409/412, edited in the studio since your last publish)\n 9 not ours: Node refuses a missing --env-file before the CLI starts (use --vars-file)\n 124 --wait timed out (the job keeps running; with --wait, a failed job is 1)";
|
|
5
|
+
export declare const LOGIN_HELP = "forumulate login \u2014 store a token for this API\n\nUsage:\n forumulate login [--token <pat>] (asks for it, hidden, when not given)\n\n The token is checked against the API first, then stored in\n ~/.config/forumulate/credentials.json (mode 0600), keyed by API base, so a\n staging token is never sent to production. On every later command a\n --token beats FORUMULATE_TOKEN, which beats the stored token.\n Mint a token at https://forumulate.com/account/tokens\n\nExit status:\n 0 ok 1 failed (verification mismatch, doctor FAIL)\n 2 usage 3 auth (no token, 401, token not allowed)\n 4 not found 5 conflict (409/412, edited in the studio since your last publish)\n 9 not ours: Node refuses a missing --env-file before the CLI starts (use --vars-file)\n 124 --wait timed out (the job keeps running; with --wait, a failed job is 1)";
|
|
6
|
+
export declare const LOGOUT_HELP = "forumulate logout \u2014 forget the stored token for this API\n\nUsage:\n forumulate logout\n\n Warns when FORUMULATE_TOKEN is still set, because it still wins.\n\nExit status:\n 0 ok 1 failed (verification mismatch, doctor FAIL)\n 2 usage 3 auth (no token, 401, token not allowed)\n 4 not found 5 conflict (409/412, edited in the studio since your last publish)\n 9 not ours: Node refuses a missing --env-file before the CLI starts (use --vars-file)\n 124 --wait timed out (the job keeps running; with --wait, a failed job is 1)";
|
|
7
|
+
export declare const SNAPSHOT_HELP = "forumulate snapshot \u2014 save a version snapshot of a space\n\nUsage:\n forumulate snapshot <orgId> <spaceId> <label\u2026> [--json]\n (also: forumulate snapshots --help)\n\nExit status:\n 0 ok 1 failed (verification mismatch, doctor FAIL)\n 2 usage 3 auth (no token, 401, token not allowed)\n 4 not found 5 conflict (409/412, edited in the studio since your last publish)\n 9 not ours: Node refuses a missing --env-file before the CLI starts (use --vars-file)\n 124 --wait timed out (the job keeps running; with --wait, a failed job is 1)";
|
|
8
|
+
export declare const CONFORMANCE_HELP = "forumulate conformance \u2014 run the Content Sync Protocol suite\n\nUsage:\n forumulate conformance <collectionUrl> [--json]\n\n Runs against any platform's collection endpoint, ours included. Exit 1 when a\n check fails.\n\nExit status:\n 0 ok 1 failed (verification mismatch, doctor FAIL)\n 2 usage 3 auth (no token, 401, token not allowed)\n 4 not found 5 conflict (409/412, edited in the studio since your last publish)\n 9 not ours: Node refuses a missing --env-file before the CLI starts (use --vars-file)\n 124 --wait timed out (the job keeps running; with --wait, a failed job is 1)";
|
|
9
|
+
export declare const CONTENT_HELP = "forumulate content \u2014 a content library's model as code\n\nUsage:\n forumulate content types --library <id|slug> [--org \u2026] [--out forumulate.d.ts]\n [--preview] [--schema <file>] [--check]\n forumulate content pull --library <id|slug> [--format json|payload] [--out <file>]\n forumulate content push [file] [--library \u2026] [--dry-run] [--yes] [--force]\n [--rename type.field=new | block:hero.field=new | library:field=new]\n [--rename-type old=new] [--rename-block old=new]\n\n Here --out names the file the command writes (not a stdout redirect).\n\nExit status:\n 0 ok 1 failed (verification mismatch, doctor FAIL)\n 2 usage 3 auth (no token, 401, token not allowed)\n 4 not found 5 conflict (409/412, edited in the studio since your last publish)\n 9 not ours: Node refuses a missing --env-file before the CLI starts (use --vars-file)\n 124 --wait timed out (the job keeps running; with --wait, a failed job is 1)";
|
|
10
|
+
export declare const IMPORT_HELP = "forumulate import mdx <folder> [--json] lists, by file and line, what would publish as literal text; exit 1 if any.\n\nforumulate import \u2014 bring another CMS's content into a library\n\nUsage:\n forumulate import <payload|contentful|sanity|strapi|wordpress> <export path>\n --library <id|slug> [--org \u2026] [--dry-run] [--yes]\n [--config payload.config.ts] [--publish source|all|none]\n [--allow-model-removals] [--pace <ms>] [--base-url <url>]\n\n Always shows a dry run first; a re-run updates what a previous import made.\n\nOutput (every command):\n --json the result as JSON on stdout; progress and warnings go to stderr\n --out <file> write stdout to a file instead (never truncated, exit 1 if the write fails)\n\nExit status:\n 0 ok 1 failed (verification mismatch, doctor FAIL)\n 2 usage 3 auth (no token, 401, token not allowed)\n 4 not found 5 conflict (409/412, edited in the studio since your last publish)\n 9 not ours: Node refuses a missing --env-file before the CLI starts (use --vars-file)\n 124 --wait timed out (the job keeps running; with --wait, a failed job is 1)";
|
|
11
|
+
export declare const TRANSLATIONS_HELP = "forumulate translations (alias i18n) \u2014 every translation capability\n\nUsage:\n forumulate translations locales list|add|relabel|remove|set [--space \u2026|--library \u2026]\n forumulate translations status [--locale es,fr] [--fail-on missing,outdated]\n forumulate translations pull [--out translations] [--locale \u2026] [--only \u2026]\n forumulate translations push [dir] [--dry-run]\n forumulate translations auto --locale es [--state missing,outdated] [--publish]\n forumulate translations labels|overrides pull|push [file] [--format json|xliff]\n forumulate translations item-locale <itemId> <locale|none>\n forumulate translations remove <pieceId> <locale> --yes\n forumulate translations entry <entryId> <locale> [--fields f.json]\n forumulate translations name <locale> <name\u2026>\n forumulate translations switcher get|set <f.json>\n forumulate translations provider status|connect|disconnect\n\n Here --out names the folder or file the command writes.\n\nExit status:\n 0 ok 1 failed (verification mismatch, doctor FAIL)\n 2 usage 3 auth (no token, 401, token not allowed)\n 4 not found 5 conflict (409/412, edited in the studio since your last publish)\n 9 not ours: Node refuses a missing --env-file before the CLI starts (use --vars-file)\n 124 --wait timed out (the job keeps running; with --wait, a failed job is 1)";
|
|
12
12
|
/** The command → its own help. A command missing here prints the global help. */
|
|
13
13
|
export declare const COMMAND_HELP: Readonly<Record<string, string>>;
|
|
14
14
|
//# sourceMappingURL=help-commands.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"help-commands.d.ts","sourceRoot":"","sources":["../src/help-commands.ts"],"names":[],"mappings":"AAuBA,eAAO,MAAM,YAAY,
|
|
1
|
+
{"version":3,"file":"help-commands.d.ts","sourceRoot":"","sources":["../src/help-commands.ts"],"names":[],"mappings":"AAuBA,eAAO,MAAM,YAAY,k9JA0EN,CAAC;AAEpB,eAAO,MAAM,SAAS,igCAYH,CAAC;AAEpB,eAAO,MAAM,SAAS,g1KAsEH,CAAC;AAEpB,eAAO,MAAM,QAAQ,spBAQF,CAAC;AAEpB,eAAO,MAAM,UAAU,62BAWJ,CAAC;AAEpB,eAAO,MAAM,WAAW,qjBAOL,CAAC;AAEpB,eAAO,MAAM,aAAa,ikBAMP,CAAC;AAEpB,eAAO,MAAM,gBAAgB,onBAQV,CAAC;AAEpB,eAAO,MAAM,YAAY,2+BAYN,CAAC;AAEpB,eAAO,MAAM,WAAW,soCAcL,CAAC;AAEpB,eAAO,MAAM,iBAAiB,02CAkBX,CAAC;AAEpB,iFAAiF;AACjF,eAAO,MAAM,YAAY,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CA8BzD,CAAC"}
|
package/dist/help-commands.js
CHANGED
|
@@ -132,6 +132,10 @@ Flags:
|
|
|
132
132
|
--prune also delete what this manifest created earlier and no longer
|
|
133
133
|
declares — only for the kinds the file declares (pages go to the trash)
|
|
134
134
|
--batch <n> apply: changed pages per request (default 20; the edge cuts a request at 30 s)
|
|
135
|
+
--vars-file <p> read \${NAME}s from a dotenv file, repeatable (later files win); values of 8+ characters
|
|
136
|
+
are masked in all output (--show-secrets reveals them); --env-file is the old name, and
|
|
137
|
+
for a missing file there Node itself exits 9 before the CLI starts; a variable already set in the shell wins
|
|
138
|
+
--show-secrets leave declared secrets in the output; refused unless stdout is a terminal
|
|
135
139
|
--allow-unset-env apply: publish a page whose \${NAME} is unset as written (default: refuse)
|
|
136
140
|
--secrets-file <p> apply: write every shown-once value (executor key, webhook secret) and every
|
|
137
141
|
heartbeat's pingUrl (monitors/<space>/<name>, on every apply) to <p> as JSON,
|
|
@@ -235,7 +239,9 @@ Usage:
|
|
|
235
239
|
Here --out names the file the command writes (not a stdout redirect).
|
|
236
240
|
|
|
237
241
|
${exit_codes_1.EXIT_CODES_HELP}`;
|
|
238
|
-
exports.IMPORT_HELP = `forumulate import
|
|
242
|
+
exports.IMPORT_HELP = `forumulate import mdx <folder> [--json] lists, by file and line, what would publish as literal text; exit 1 if any.
|
|
243
|
+
|
|
244
|
+
forumulate import — bring another CMS's content into a library
|
|
239
245
|
|
|
240
246
|
Usage:
|
|
241
247
|
forumulate import <payload|contentful|sanity|strapi|wordpress> <export path>
|
|
@@ -283,6 +289,15 @@ exports.COMMAND_HELP = {
|
|
|
283
289
|
conformance: exports.CONFORMANCE_HELP,
|
|
284
290
|
content: exports.CONTENT_HELP,
|
|
285
291
|
import: exports.IMPORT_HELP,
|
|
292
|
+
pull: `forumulate pull <folder> --space <slug> [--org <id|slug>]
|
|
293
|
+
|
|
294
|
+
Studio edits back into the folder, as Markdown. A file that already holds a page keeps its name and
|
|
295
|
+
front matter, and a page not edited since it was last published is left alone. A new page gets its
|
|
296
|
+
collection's folder, and its metadata, order and parent in front matter.`,
|
|
297
|
+
'domains records': `forumulate domains records [forumulate.yaml] [--org <o>] [--json] [--format cloudflare] [--vars-file <p>]
|
|
298
|
+
|
|
299
|
+
The DNS records a plan waits for, as data. They exist once a domain is claimed: before the first
|
|
300
|
+
apply there are none, and stderr names the domains still to claim.`,
|
|
286
301
|
translations: exports.TRANSLATIONS_HELP,
|
|
287
302
|
i18n: exports.TRANSLATIONS_HELP,
|
|
288
303
|
check: command_2.CHECK_HELP,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"help-commands.js","sourceRoot":"","sources":["../src/help-commands.ts"],"names":[],"mappings":";;;AAAA,2DAAqD;AACrD,yCAA2C;AAC3C,8CAA+C;AAC/C,6CAA+C;AAC/C,qCAAuC;AACvC,mDAA6C;AAC7C,6EAA6E;AAC7E,6CAAiE;AAEjE;;;;;;;;;GASG;AACH,MAAM,MAAM,GAAG;;8FAE+E,CAAC;AAElF,QAAA,YAAY,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAwE1B,MAAM;;EAEN,4BAAe,EAAE,CAAC;AAEP,QAAA,SAAS,GAAG;;;;;;;;;;EAUvB,MAAM;;EAEN,4BAAe,EAAE,CAAC;AAEP,QAAA,SAAS,GAAG
|
|
1
|
+
{"version":3,"file":"help-commands.js","sourceRoot":"","sources":["../src/help-commands.ts"],"names":[],"mappings":";;;AAAA,2DAAqD;AACrD,yCAA2C;AAC3C,8CAA+C;AAC/C,6CAA+C;AAC/C,qCAAuC;AACvC,mDAA6C;AAC7C,6EAA6E;AAC7E,6CAAiE;AAEjE;;;;;;;;;GASG;AACH,MAAM,MAAM,GAAG;;8FAE+E,CAAC;AAElF,QAAA,YAAY,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAwE1B,MAAM;;EAEN,4BAAe,EAAE,CAAC;AAEP,QAAA,SAAS,GAAG;;;;;;;;;;EAUvB,MAAM;;EAEN,4BAAe,EAAE,CAAC;AAEP,QAAA,SAAS,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAoEvB,MAAM;;EAEN,4BAAe,EAAE,CAAC;AAEP,QAAA,QAAQ,GAAG;;;;;;;;EAQtB,4BAAe,EAAE,CAAC;AAEP,QAAA,UAAU,GAAG;;;;;;;;;;;EAWxB,4BAAe,EAAE,CAAC;AAEP,QAAA,WAAW,GAAG;;;;;;;EAOzB,4BAAe,EAAE,CAAC;AAEP,QAAA,aAAa,GAAG;;;;;;EAM3B,4BAAe,EAAE,CAAC;AAEP,QAAA,gBAAgB,GAAG;;;;;;;;EAQ9B,4BAAe,EAAE,CAAC;AAEP,QAAA,YAAY,GAAG;;;;;;;;;;;;EAY1B,4BAAe,EAAE,CAAC;AAEP,QAAA,WAAW,GAAG;;;;;;;;;;;;EAYzB,MAAM;;EAEN,4BAAe,EAAE,CAAC;AAEP,QAAA,iBAAiB,GAAG;;;;;;;;;;;;;;;;;;EAkB/B,4BAAe,EAAE,CAAC;AAEpB,iFAAiF;AACpE,QAAA,YAAY,GAAqC;IAC5D,OAAO,EAAE,oBAAY;IACrB,IAAI,EAAE,iBAAS;IACf,GAAG,EAAE,gBAAQ;IACb,MAAM,EAAE,qBAAW;IACnB,QAAQ,EAAE,wBAAa;IACvB,KAAK,EAAE,kBAAU;IACjB,MAAM,EAAE,mBAAW;IACnB,MAAM,EAAE,oBAAW;IACnB,IAAI,EAAE,oBAAW;IACjB,KAAK,EAAE,0BAAU;IACjB,QAAQ,EAAE,qBAAa;IACvB,WAAW,EAAE,wBAAgB;IAC7B,OAAO,EAAE,oBAAY;IACrB,MAAM,EAAE,mBAAW;IACnB,IAAI,EAAE;;;;yEAIiE;IACvE,iBAAiB,EAAE;;;mEAG8C;IACjE,YAAY,EAAE,yBAAiB;IAC/B,IAAI,EAAE,yBAAiB;IACvB,KAAK,EAAE,oBAAgB;IACvB,IAAI,EAAE,iBAAS;IACf,KAAK,EAAE,iBAAS;IAChB,SAAS,EAAE,kCAAc;CAC1B,CAAC"}
|
package/dist/help.d.ts
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
/** `forumulate help`. The resource groups print their own (`forumulate spaces --help`). */
|
|
2
|
-
export declare const HELP = "forumulate \u2014 Forumulate command-line interface\n\nUsage:\n forumulate <command> [args]\n\nCommands:\n login [--token <pat>] Store a token for this API, so every other\n command stops needing FORUMULATE_TOKEN in\n the environment\n logout Forget the stored token\n whoami [--json] Who you are, and WHICH token: its source (--token,\n FORUMULATE_TOKEN or credentials.json), id, name,\n last 4, expiry, narrowing and the API base\n auth status [--json] The same report, for scripts\n config set|get|unset|list Defaults: org, space, library, api-version\n (`forumulate config set org acme`)\n\nEvery API operation:\n api list [--tag t] [--search w] Discover operations and their summaries\n [--refresh] ...from the live API's spec, not the bundled one\n api describe <operationId> Parameters and body schema, as flags\n api <operationId> [args] [flags] Call it: --<param> value, --data @f.json,\n api <METHOD> <path> [flags] --field a.b=v, --paginate, --json\n\nResources (each: <group> --help lists its verbs and the operation each calls):\n Org: orgs | members | invites | groups | roles | service-accounts (bots)\n tokens (pats) | keys | integration-tokens (int-tokens)\n webhooks | extensions | audit\n Spaces: spaces | snapshots | shape | domains | assets | space-types (types)\n Docs: items (pages) | docs | collections | versions | change-requests (crs)\n openapi | sdks | github (git)\n Content: blog | forum | changelog | roadmap | status | events | course\n careers | forms | about (blog/forum/changelog/status: translations \u2026)\n CMS: libraries | entries | media | releases | environments (envs)\n Site: theme | sites | reader\n Jobs: jobs | backups | imports | manifest (starters take --wait [--timeout s])\n search <query...> [--org] e.g. spaces create Docs --slug docs --type DOCS\n items create --space docs --file a.md --publish\n docs schedule set <pageId> <when> --space docs\n webhooks deliveries <id>; webhooks replay <id> <d>\n --out <file> where a file answer goes (SDK archive, PDF, CSV export)\n cache purge --space <s> [--page p] Drop cached copies (web tier + every CDN); deletes\n nothing\n completion bash|zsh|fish Shell completion script\n\nOlder forms, unchanged:\n orgs List your organizations\n spaces <orgId> List spaces in an org\n items <orgId> <spaceId> List what is in a space, with where each\n piece's content lives\n search <orgId> <query...> Unified search across docs/forum/blog\n dev <folder> Preview a folder of Markdown locally, rendered\n by your space's own renderer; reloads on save.\n --org <id> --space <id> [--port 4321] [--site <your docs URL>]\n publish <folder> --org <o> --space <s>\n Publish a folder of Markdown: one folder per\n collection, front matter, assets, order,\n and a forumulate.yaml manifest for space,\n site, theme, OpenAPI and monitors. Re-runs\n change only what changed, then read back.\n --org <id|slug> --space <id|slug> (or org:/space: in the manifest)\n --dry-run print the plan, write nothing (no token needed for a\n public space)\n --prune remove pages/posts/collections with no file (to the trash)\n --only a,b just these slugs, files, folders, or manifest parts\n (site, theme, settings, openapi, monitors)\n --force re-send every page even if it looks unchanged\n --no-verify skip the read-back --pace <ms> gap between writes\n --manifest <file> a manifest somewhere else\n --diff print the changed paragraphs and fields of each update\n --purge page|space|none what to drop from the cache (default page),\n reported per CDN\n --json one summary: created, updated, unchanged, trashed, purged,\n verify, diffUrl (the run is recorded; publish.completed fires)\n Pages edited in the studio since the last publish are not overwritten\n without --force. Full reference: forumulate publish --help\n sync <folder> Content as code: the same folder publish,\n PLAN BY DEFAULT. Posts (blog), pages\n (docs, custom, legal), FAQ questions,\n changelog releases and blog categories,\n matched by slug; images uploaded once by\n content hash; README, LICENSE, _drafts/,\n dotfiles skipped. Guide:\n https://forumulate.com/guides/content-as-code\n --apply write the plan (then read it back)\n --prune also remove what has no file (to the trash)\n --diff print the changed paragraphs and fields of each update\n --org, --space, --only, --force, --no-verify, --pace, --manifest, --json\n as for publish\n plan [forumulate.yaml] The whole site as one document (version: 2):\n spaces and their SEO, languages, front doors,\n contact form and About parts, Markdown pages\n with locale twins, redirects, sites. Prints\n the diff; writes nothing. --check exits 1\n when it is not empty. Full reference:\n forumulate plan --help\n apply [forumulate.yaml] Carry that plan out, idempotently, every\n write read back; --prune also removes what\n the manifest wrote and no longer declares\n --secrets-file <p> keeps the shown-once keys (0600);\n the output redacts them\n heartbeat ping <monitor> [--fail] Report a job's pass to a heartbeat monitor\n (--message <why> with --fail); forumulate heartbeat --help\n heartbeat ping-url <monitor> Print that monitor's ping URL (it holds its secret)\n orgs ensure <slug> [--name <n>] The organization, created only when missing; safe to\n [--external-ref <ref>] re-run (run it before the first plan/apply)\n domains setup <host> --space <s> What a domain still waits for: mode, pendingReason,\n message; then domains verify / activate <host>\n check links [folder] Broken internal links, #anchors, pictures and\n (--external) outside links in a folder, before\n publishing; exit 1 when any is broken\n --space <s> [--org <o>] the same report for a published space\n --allow-redirect <hosts> --ignore <text> --json\n publish <folder> --preview <name> Send the change to a preview link instead of\n publishing it (--comment posts it on the PR)\n domains <orgId> <spaceId> List this space's domains and their state\n domains verify <orgId> <spaceId> <hostname>\n Re-run verification and say what is missing\n snapshot <orgId> <spaceId> <label> Create a space version snapshot\n content types --library <id|slug> TypeScript for a content library's model:\n collections, globals, the block union\n [--org <id|slug>] [--out forumulate.d.ts] [--preview] [--schema <file>]\n [--check] fail (exit 1) when the file is out of date, write nothing\n content pull --library <id|slug> Write the model to forumulate.content.json\n [--format json|payload] [--out <file>] (payload: forumulate.payload.ts)\n content push [file] Show the diff against the library, then\n apply it as a new model version\n [--library \u2026] [--dry-run] [--yes] [--force]\n [--rename type.field=new | block:hero.field=new | library:field=new]\n [--rename-type old=new] [--rename-block old=new]\n import <payload|contentful|sanity|strapi|wordpress> <export path>\n Bring another CMS's content into a library:\n model, media, entries, references (always\n shows a dry run first)\n Re-running updates entries a\n previous import made. strapi takes a\n folder or an unencrypted export .tar.gz\n --library <id|slug> [--org \u2026] [--dry-run] [--yes]\n [--config payload.config.ts] (payload) the config that becomes the model\n [--publish source|all|none] what to publish (default: what was live)\n [--allow-model-removals] [--pace <ms>] [--base-url <url>] (strapi uploads)\n translations (alias i18n) Every translation capability, one vocabulary\n locales list|add|relabel|remove|set a space's (--space) or library's\n (--library) languages; set es=Espa\u00F1ol fr [--prune] is exact\n status each piece \u00D7 language: missing/draft/published/outdated\n [--locale es,fr] [--fail-on missing,outdated] (exit 1)\n pull one Markdown file per piece per language \u2192 [--out translations]\n [--locale \u2026] [--only slug,\u2026] [--include-missing] (stubs)\n push [dir] diff the files against the API, write what changed [--dry-run]\n auto machine-translate with YOUR DeepL/AI key --locale es\n [--state missing,outdated] [--only \u2026] [--force] [--publish]\n [--library \u2026 --entry id,\u2026] [--dry-run]\n labels pull|push [file] chrome words (--site <id> | --space \u2026)\n overrides pull|push [file] org UI string overrides [--prune]\n [--format json|xliff] for labels and overrides\n item-locale <itemId> <locale|none> correct a piece's declared language\n remove <pieceId> <locale> one translation (--yes)\n entry <entryId> <locale> a library entry's twin [--fields f.json]\n name <locale> <name\u2026> a space's (or --collection's) name\n switcher get|set <f.json> the org's reader language switcher\n provider status|connect|disconnect your DeepL key (DEEPL_API_KEY)\n conformance <collectionUrl> Run the Content Sync Protocol suite against\n any platform's collection endpoint\n validate [dir] Check forumulate.yaml, front matter and $schema\n files against the published schemas, with\n did-you-mean hints. --json; exit 2 if invalid\n doctor <readerUrl> | --site <s> Check a live site from the outside: health,\n canonical on both addresses, sitemap, cache\n consistency, root redirect, descriptions,\n llms.txt, favicon, consent tag, white-label\n leaks. --json; exit 1 on any FAIL\n help [command] Show this help, or a command's own\n (every command also takes --help)\n\nEnvironment:\n FORUMULATE_TOKEN Personal Access Token (Bearer). Overrides a stored one, so\n CI keeps working exactly as it did; --token overrides it.\n Mint one at\n https://forumulate.com/account/tokens\n FORUMULATE_URL The site (default https://forumulate.com); the API is its\n /api, i.e. https://forumulate.com/api. A value already\n ending in /api is used as-is.\n FORUMULATE_API_URL Exact API base, for a local API with no /api prefix\n (http://localhost:4000). Wins over FORUMULATE_URL.\n FORUMULATE_API is read as the same thing.\n FORUMULATE_ORG, FORUMULATE_SPACE, FORUMULATE_LIBRARY\n Defaults for --org, --space and --library; they beat\n `forumulate config set`, a flag beats both.\n FORUMULATE_API_VERSION\n Forumulate-Version for api/resource commands\n (default: the SDK's current version).\n\nThe SDK (ForumulateClient.fromEnv) and the MCP server (@forumulate/mcp) read\nthe same variables. Guide: https://forumulate.com/guides/api-tokens-and-scopes\n\nEvery FORUMULATE_* variable not listed above is reported (with the one you\nprobably meant) by `forumulate whoami` and on any authentication failure.\n\nFlags:\n --json Emit raw JSON instead of a formatted summary (stdout only;\n progress and warnings go to stderr)\n --out <file> Write stdout to a file (never truncated; non-zero exit if the\n write fails). content/translations use --out for their own file\n --jsonl With --paginate: one JSON row per line, streamed\n --token <pat> The token for this run, on every command. Precedence:\n --token, then FORUMULATE_TOKEN, then credentials.json. On an\n operation with a `token` parameter of its own (registries\n set, github connect, domains acme-challenge) the flag is that\n parameter; set FORUMULATE_TOKEN for the PAT there\n --dry-run (api, resources) print the request instead of sending it\n --dry-run Plan the work and write nothing (publish of a directory)\n --version Print the CLI version\n\nExit status:\n 0 ok 1 failed (verification mismatch, doctor FAIL) 2 usage\n 3 auth (no token, 401, token not allowed) 4 not found\n 5 conflict (409/412, edited in the studio since your last publish)\n";
|
|
2
|
+
export declare const HELP = "forumulate \u2014 Forumulate command-line interface\n\nUsage:\n forumulate <command> [args]\n\nCommands:\n login [--token <pat>] Store a token for this API, so every other\n command stops needing FORUMULATE_TOKEN in\n the environment\n logout Forget the stored token\n whoami [--json] Who you are, and WHICH token: its source (--token,\n FORUMULATE_TOKEN or credentials.json), id, name,\n last 4, expiry, narrowing and the API base\n auth status [--json] The same report, for scripts\n config set|get|unset|list Defaults: org, space, library, api-version\n (`forumulate config set org acme`)\n\nEvery API operation:\n api list [--tag t] [--search w] Discover operations and their summaries\n [--refresh] ...from the live API's spec, not the bundled one\n api describe <operationId> Parameters and body schema, as flags\n api <operationId> [args] [flags] Call it: --<param> value, --data @f.json,\n api <METHOD> <path> [flags] --field a.b=v, --paginate, --json\n\nResources (each: <group> --help lists its verbs and the operation each calls):\n Org: orgs | members | invites | groups | roles | service-accounts (bots)\n tokens (pats) | keys | integration-tokens (int-tokens)\n webhooks | extensions | audit\n Spaces: spaces | snapshots | shape | domains | assets | space-types (types)\n Docs: items (pages) | docs | collections | versions | change-requests (crs)\n openapi | sdks | github (git)\n Content: blog | forum | changelog | roadmap | status | events | course\n careers | forms | about (blog/forum/changelog/status: translations \u2026)\n CMS: libraries | entries | media | releases | environments (envs)\n Site: theme | sites | reader\n Jobs: jobs | backups | imports | manifest (starters take --wait [--timeout s])\n search <query...> [--org] e.g. spaces create Docs --slug docs --type DOCS\n items create --space docs --file a.md --publish\n docs schedule set <pageId> <when> --space docs\n webhooks deliveries <id>; webhooks replay <id> <d>\n --out <file> where a file answer goes (SDK archive, PDF, CSV export)\n cache purge --space <s> [--page p] Drop cached copies (web tier + every CDN); deletes\n nothing\n completion bash|zsh|fish Shell completion script\n\nOlder forms, unchanged:\n orgs List your organizations\n spaces <orgId> List spaces in an org\n items <orgId> <spaceId> List what is in a space, with where each\n piece's content lives\n search <orgId> <query...> Unified search across docs/forum/blog\n dev <folder> Preview a folder of Markdown locally, rendered\n by your space's own renderer; reloads on save.\n --org <id> --space <id> [--port 4321] [--site <your docs URL>]\n publish <folder> --org <o> --space <s>\n Publish a folder of Markdown: one folder per\n collection, front matter, assets, order,\n and a forumulate.yaml manifest for space,\n site, theme, OpenAPI and monitors. Re-runs\n change only what changed, then read back.\n --org <id|slug> --space <id|slug> (or org:/space: in the manifest)\n --dry-run print the plan, write nothing (no token needed for a\n public space)\n --prune remove pages/posts/collections with no file (to the trash)\n --only a,b just these slugs, files, folders, or manifest parts\n (site, theme, settings, openapi, monitors)\n --force re-send every page even if it looks unchanged\n --no-verify skip the read-back --pace <ms> gap between writes\n --manifest <file> a manifest somewhere else\n --diff print the changed paragraphs and fields of each update\n --purge page|space|none what to drop from the cache (default page),\n reported per CDN\n --json one summary: created, updated, unchanged, trashed, purged,\n verify, diffUrl (the run is recorded; publish.completed fires)\n Pages edited in the studio since the last publish are not overwritten\n without --force. Full reference: forumulate publish --help\n sync <folder> Content as code: the same folder publish,\n PLAN BY DEFAULT. Posts (blog), pages\n (docs, custom, legal), FAQ questions,\n changelog releases and blog categories,\n matched by slug; images uploaded once by\n content hash; README, LICENSE, _drafts/,\n dotfiles skipped. Guide:\n https://forumulate.com/guides/content-as-code\n --apply write the plan (then read it back)\n --prune also remove what has no file (to the trash)\n --diff print the changed paragraphs and fields of each update\n --org, --space, --only, --force, --no-verify, --pace, --manifest, --json\n as for publish\n plan [forumulate.yaml] The whole site as one document (version: 2):\n spaces and their SEO, languages, front doors,\n contact form and About parts, Markdown pages\n with locale twins, redirects, sites. Prints\n the diff; writes nothing. --check exits 1\n when it is not empty. Full reference:\n forumulate plan --help\n apply [forumulate.yaml] Carry that plan out, idempotently, every\n write read back; --prune also removes what\n the manifest wrote and no longer declares\n --secrets-file <p> keeps the shown-once keys (0600);\n the output redacts them\n plan and apply: --vars-file <p> (repeatable) reads ${NAME}s from a dotenv file (the shell wins);\n declared secrets are masked in all output (--show-secrets on a terminal shows them)\n pull <folder> --space <s> Studio edits back into the folder, as Markdown; the\n next step when plan --check names an edited page\n init --from-site <folder> A first forumulate.yaml from the Markdown a site has\n import mdx <folder> What in these files would publish as literal text,\n with file and line; exit 1 when anything would\n domains records [forumulate.yaml] The DNS records a plan waits for, as data:\n [--json] [--format cloudflare] type, name, value, proxied: false\n heartbeat ping <monitor> [--fail] Report a job's pass to a heartbeat monitor\n (--message <why> with --fail); forumulate heartbeat --help\n heartbeat ping-url <monitor> Print that monitor's ping URL (it holds its secret)\n orgs ensure <slug> [--name <n>] The organization, created only when missing; safe to\n [--external-ref <ref>] re-run (run it before the first plan/apply)\n domains setup <host> --space <s> What a domain still waits for: mode, pendingReason,\n message; then domains verify / activate <host>\n check links [folder] Broken internal links, #anchors, pictures and\n (--external) outside links in a folder, before\n publishing; exit 1 when any is broken\n --space <s> [--org <o>] the same report for a published space\n --allow-redirect <hosts> --ignore <text> --json\n publish <folder> --preview <name> Send the change to a preview link instead of\n publishing it (--comment posts it on the PR)\n domains <orgId> <spaceId> List this space's domains and their state\n domains verify <orgId> <spaceId> <hostname>\n Re-run verification and say what is missing\n snapshot <orgId> <spaceId> <label> Create a space version snapshot\n content types --library <id|slug> TypeScript for a content library's model:\n collections, globals, the block union\n [--org <id|slug>] [--out forumulate.d.ts] [--preview] [--schema <file>]\n [--check] fail (exit 1) when the file is out of date, write nothing\n content pull --library <id|slug> Write the model to forumulate.content.json\n [--format json|payload] [--out <file>] (payload: forumulate.payload.ts)\n content push [file] Show the diff against the library, then\n apply it as a new model version\n [--library \u2026] [--dry-run] [--yes] [--force]\n [--rename type.field=new | block:hero.field=new | library:field=new]\n [--rename-type old=new] [--rename-block old=new]\n import <payload|contentful|sanity|strapi|wordpress> <export path>\n Bring another CMS's content into a library:\n model, media, entries, references (always\n shows a dry run first)\n Re-running updates entries a\n previous import made. strapi takes a\n folder or an unencrypted export .tar.gz\n --library <id|slug> [--org \u2026] [--dry-run] [--yes]\n [--config payload.config.ts] (payload) the config that becomes the model\n [--publish source|all|none] what to publish (default: what was live)\n [--allow-model-removals] [--pace <ms>] [--base-url <url>] (strapi uploads)\n translations (alias i18n) Every translation capability, one vocabulary\n locales list|add|relabel|remove|set a space's (--space) or library's\n (--library) languages; set es=Espa\u00F1ol fr [--prune] is exact\n status each piece \u00D7 language: missing/draft/published/outdated\n [--locale es,fr] [--fail-on missing,outdated] (exit 1)\n pull one Markdown file per piece per language \u2192 [--out translations]\n [--locale \u2026] [--only slug,\u2026] [--include-missing] (stubs)\n push [dir] diff the files against the API, write what changed [--dry-run]\n auto machine-translate with YOUR DeepL/AI key --locale es\n [--state missing,outdated] [--only \u2026] [--force] [--publish]\n [--library \u2026 --entry id,\u2026] [--dry-run]\n labels pull|push [file] chrome words (--site <id> | --space \u2026)\n overrides pull|push [file] org UI string overrides [--prune]\n [--format json|xliff] for labels and overrides\n item-locale <itemId> <locale|none> correct a piece's declared language\n remove <pieceId> <locale> one translation (--yes)\n entry <entryId> <locale> a library entry's twin [--fields f.json]\n name <locale> <name\u2026> a space's (or --collection's) name\n switcher get|set <f.json> the org's reader language switcher\n provider status|connect|disconnect your DeepL key (DEEPL_API_KEY)\n conformance <collectionUrl> Run the Content Sync Protocol suite against\n any platform's collection endpoint\n validate [dir] Check forumulate.yaml, front matter and $schema\n files against the published schemas, with\n did-you-mean hints. --json; exit 2 if invalid\n doctor <readerUrl> | --site <s> Check a live site from the outside: health,\n canonical on both addresses, sitemap, cache\n consistency, root redirect, descriptions,\n llms.txt, favicon, consent tag, white-label\n leaks. --json; exit 1 on any FAIL\n help [command] Show this help, or a command's own\n (every command also takes --help)\n\nEnvironment:\n FORUMULATE_TOKEN Personal Access Token (Bearer). Overrides a stored one, so\n CI keeps working exactly as it did; --token overrides it.\n Mint one at\n https://forumulate.com/account/tokens\n FORUMULATE_URL The site (default https://forumulate.com); the API is its\n /api, i.e. https://forumulate.com/api. A value already\n ending in /api is used as-is.\n FORUMULATE_API_URL Exact API base, for a local API with no /api prefix\n (http://localhost:4000). Wins over FORUMULATE_URL.\n FORUMULATE_API is read as the same thing.\n FORUMULATE_ORG, FORUMULATE_SPACE, FORUMULATE_LIBRARY\n Defaults for --org, --space and --library; they beat\n `forumulate config set`, a flag beats both.\n FORUMULATE_API_VERSION\n Forumulate-Version for api/resource commands\n (default: the SDK's current version).\n\nThe SDK (ForumulateClient.fromEnv) and the MCP server (@forumulate/mcp) read\nthe same variables. Guide: https://forumulate.com/guides/api-tokens-and-scopes\n\nEvery FORUMULATE_* variable not listed above is reported (with the one you\nprobably meant) by `forumulate whoami` and on any authentication failure.\n\nFlags:\n --json Emit raw JSON instead of a formatted summary (stdout only;\n progress and warnings go to stderr)\n --out <file> Write stdout to a file (never truncated; non-zero exit if the\n write fails). content/translations use --out for their own file\n --jsonl With --paginate: one JSON row per line, streamed\n --token <pat> The token for this run, on every command. Precedence:\n --token, then FORUMULATE_TOKEN, then credentials.json. On an\n operation with a `token` parameter of its own (registries\n set, github connect, domains acme-challenge) the flag is that\n parameter; set FORUMULATE_TOKEN for the PAT there\n --dry-run (api, resources) print the request instead of sending it\n --dry-run Plan the work and write nothing (publish of a directory)\n --version Print the CLI version\n\nExit status:\n 0 ok 1 failed (verification mismatch, doctor FAIL) 2 usage\n 3 auth (no token, 401, token not allowed) 4 not found\n 5 conflict (409/412, edited in the studio since your last publish)\n";
|
|
3
3
|
//# sourceMappingURL=help.d.ts.map
|
package/dist/help.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"help.d.ts","sourceRoot":"","sources":["../src/help.ts"],"names":[],"mappings":"AAAA,2FAA2F;AAC3F,eAAO,MAAM,IAAI,
|
|
1
|
+
{"version":3,"file":"help.d.ts","sourceRoot":"","sources":["../src/help.ts"],"names":[],"mappings":"AAAA,2FAA2F;AAC3F,eAAO,MAAM,IAAI,yveAkOhB,CAAC"}
|
package/dist/help.js
CHANGED
|
@@ -103,6 +103,15 @@ Older forms, unchanged:
|
|
|
103
103
|
the manifest wrote and no longer declares
|
|
104
104
|
--secrets-file <p> keeps the shown-once keys (0600);
|
|
105
105
|
the output redacts them
|
|
106
|
+
plan and apply: --vars-file <p> (repeatable) reads \${NAME}s from a dotenv file (the shell wins);
|
|
107
|
+
declared secrets are masked in all output (--show-secrets on a terminal shows them)
|
|
108
|
+
pull <folder> --space <s> Studio edits back into the folder, as Markdown; the
|
|
109
|
+
next step when plan --check names an edited page
|
|
110
|
+
init --from-site <folder> A first forumulate.yaml from the Markdown a site has
|
|
111
|
+
import mdx <folder> What in these files would publish as literal text,
|
|
112
|
+
with file and line; exit 1 when anything would
|
|
113
|
+
domains records [forumulate.yaml] The DNS records a plan waits for, as data:
|
|
114
|
+
[--json] [--format cloudflare] type, name, value, proxied: false
|
|
106
115
|
heartbeat ping <monitor> [--fail] Report a job's pass to a heartbeat monitor
|
|
107
116
|
(--message <why> with --fail); forumulate heartbeat --help
|
|
108
117
|
heartbeat ping-url <monitor> Print that monitor's ping URL (it holds its secret)
|
package/dist/help.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"help.js","sourceRoot":"","sources":["../src/help.ts"],"names":[],"mappings":";;;AAAA,2FAA2F;AAC9E,QAAA,IAAI,GAAG
|
|
1
|
+
{"version":3,"file":"help.js","sourceRoot":"","sources":["../src/help.ts"],"names":[],"mappings":";;;AAAA,2FAA2F;AAC9E,QAAA,IAAI,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkOnB,CAAC"}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* MDX is converted by the API at every door (`apps/api/src/docs/import-mdx.ts`), so
|
|
3
|
+
* nothing here rewrites a file. What was missing is knowing BEFORE publishing what it
|
|
4
|
+
* will not understand: a converter that claimed success while 248 tags stayed literal
|
|
5
|
+
* cost a customer a release. This list is that module's; a test keeps the two equal.
|
|
6
|
+
*/
|
|
7
|
+
export declare const MDX_COMPONENTS: string[];
|
|
8
|
+
export interface MdxProblem {
|
|
9
|
+
file: string;
|
|
10
|
+
line: number;
|
|
11
|
+
what: string;
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* What would publish as literal text, skipping fences and inline code: tags of either case no door
|
|
15
|
+
* converts, and in `.mdx` a `{expression}` or `{/* comment *\/}`. `import`/`export` are stripped from
|
|
16
|
+
* `.mdx` by publish, so only a `.md` file's count. A test publishes these fixtures through the real
|
|
17
|
+
* converter (`import-mdx-lint.test.ts`): a clean lint means no literal output.
|
|
18
|
+
*/
|
|
19
|
+
export declare function mdxProblems(text: string, file: string): MdxProblem[];
|
|
20
|
+
export declare function runImportMdx(folder: string, flags: {
|
|
21
|
+
space?: string;
|
|
22
|
+
org?: string;
|
|
23
|
+
json?: boolean;
|
|
24
|
+
}, deps: {
|
|
25
|
+
out: (l: string) => void;
|
|
26
|
+
err: (l: string) => void;
|
|
27
|
+
}): number;
|
|
28
|
+
/**
|
|
29
|
+
* `forumulate init --from-site <folder>`: the first manifest, from the Markdown a site
|
|
30
|
+
* already has. It writes only what it found and never replaces a file. A folder called
|
|
31
|
+
* blog or posts is a blog; any other is docs.
|
|
32
|
+
*/
|
|
33
|
+
export declare function runInitFromSite(root: string, flags: {
|
|
34
|
+
org?: string;
|
|
35
|
+
}, deps: {
|
|
36
|
+
out: (l: string) => void;
|
|
37
|
+
err: (l: string) => void;
|
|
38
|
+
cwd?: string;
|
|
39
|
+
}): number;
|
|
40
|
+
//# sourceMappingURL=mdx.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"mdx.d.ts","sourceRoot":"","sources":["../../src/import/mdx.ts"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH,eAAO,MAAM,cAAc,UAM1B,CAAC;AAGF,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAKD;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU,EAAE,CAyBpE;AAaD,wBAAgB,YAAY,CAC1B,MAAM,EAAE,MAAM,EACd,KAAK,EAAE;IAAE,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,OAAO,CAAA;CAAE,EACvD,IAAI,EAAE;IAAE,GAAG,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IAAC,GAAG,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,IAAI,CAAA;CAAE,GAC3D,MAAM,CAmBR;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAC7B,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE;IAAE,GAAG,CAAC,EAAE,MAAM,CAAA;CAAE,EACvB,IAAI,EAAE;IAAE,GAAG,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IAAC,GAAG,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CAAE,GACzE,MAAM,CAqCR"}
|