root/fusion
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

FN-5813: update fn onboard help and CLI docs

Browse Source 
Align onboarding HELP text and CLI reference with current fn onboarding behavior.

- Document onboarding auto-launch conditions around missing central DB and interactive command flow.
- Add and clarify onboarding escape hatches: --skip-onboarding and FUSION_SKIP_ONBOARDING.
- Add an onboard docs parity test to keep HELP and docs aligned for key onboarding terms.
- Add a patch changeset for @runfusion/fusion describing the documentation/help update.

Files changed:
 .changeset/fn-5813-onboard-docs.md                 |  5 ++++
 docs/cli-reference.md                              | 21 +++++++++-----
 packages/cli/src/bin.ts                            |  4 ++-
 packages/cli/src/commands/__tests__/onboard-docs.test.ts    | 33 ++++++++++++++++++++++
 4 files changed, 55 insertions(+), 8 deletions(-)

Fusion-Task-Id: FN-5813

Fusion-Task-Lineage: 14a74ad9-5f09-471a-878d-aa120a28ef41
This commit is contained in:
gsxdsm
2026-06-01 17:15:11 -07:00
parent 245129e24c
commit c676cbe12f
4 changed files with 55 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/cli-reference.md
View File

@@ -58,20 +58,27 @@ the onboarding flow.
```bash
fn onboard
fn onboard --force
fn --skip-onboarding dashboard
FUSION_SKIP_ONBOARDING=1 fn dashboard
```
| Option | Description |
|---|---|
| `--force` | Re-run onboarding even when `cliOnboardingCompletedAt` is already set. |
| `--skip-onboarding` | Global escape hatch that bypasses onboarding auto-launch for this invocation. |
| `FUSION_SKIP_ONBOARDING` | Environment-variable escape hatch (`1`, `true`, `yes`, or `on`) that bypasses onboarding auto-launch. |
The command is safe to re-run and only updates the settings you confirm during
prompts.
On successful completion, Fusion records `cliOnboardingCompletedAt` in global
settings.
Backward compatibility guarantee: onboarding auto-launch never interrupts
existing setups and never blocks headless usage. It is skipped when both the
central DB and local project DB already exist, and it never prompts in non-TTY,
`serve`, `daemon`, `--skip-onboarding`, `FUSION_SKIP_ONBOARDING`, piped, or
agent-run invocations.
Auto-launch behavior: before interactive commands, Fusion auto-launches onboarding
only when the central DB at `getDefaultCentralDbPath()` is missing. Auto-launch
is skipped for `serve`, `daemon`, non-TTY runs, `--skip-onboarding`, and
`FUSION_SKIP_ONBOARDING`.
Backward-compatibility guard: existing setups are never blocked — when central DB
already exists (including the central-DB + registered-project case), onboarding
does not auto-launch.
---