@funnelsgrove/cli
v0.1.11
Published
FunnelsGrove command-line tools for editing, syncing, and publishing funnels
Readme
FunnelsGrove CLI
Install:
npm install -g @funnelsgrove/cli
fgrove loginSync a funnel into its own local folder:
fgrove sync down --funnel claimbee-ios --dir ./claimbee-ios
cd ./claimbee-iosCommon workflow:
fgrove status
fgrove docs
fgrove sync up --message 'Update funnel copy'
fgrove publish --env previewInside a synced folder, fgrove reads .funnelsgrove-sync.json first, so you do not need to run fgrove use when switching between local funnel directories. Use fgrove use only when you want a global fallback context for commands outside a synced folder.
Use fgrove env pull from a synced folder to refresh only the ignored local .env file after project settings change, without replacing source files.
GitHub sync workflow:
fgrove github status --funnel claimbee-general
fgrove github connect --funnel claimbee-general --account The-Solid-Grove --repo claimbee-funnel
fgrove github push --funnel claimbee-general
fgrove github pull --funnel claimbee-general
fgrove publish --funnel claimbee-general --env previewThe GitHub commands use the FunnelsGrove API only. When GitHub is connected, fgrove sync up pushes the resulting draft to GitHub before returning, and fgrove publish waits for the current draft to reach GitHub before publishing. Local .env* files remain CLI-local runtime material from sync down; they are not sent to GitHub sync.
Analytics workflow:
fgrove analytics conversions --project claimbee --funnel claimbee-ios --date 2026-06-11
fgrove analytics funnel-path --project claimbee --funnel claimbee-ios --date 2026-06-11
fgrove analytics transitions --project claimbee --funnel claimbee-ios --date 2026-06-11
fgrove analytics cohort --project claimbee --date 2026-06-11Each analytics command accepts --format table|json, --out <path>, --workspace, and --timezone. Use JSON for agents and automations:
fgrove analytics conversions --project claimbee --funnel claimbee-ios --date 2026-06-11 --format json --out conversions.jsonconversions downloads the one-day conversion totals, primary conversion metrics, full funnel path rows, and step transitions. funnel-path focuses on the ordered path report. transitions focuses on step-by-step advanced/drop-off counts. cohort downloads synced marketing cohort economics for the day. If the requested day has no synced data, or cohort source data is incomplete, the CLI exits non-zero with a human-readable explanation.
The package also keeps the longer funnelsgrove command as a compatibility alias.
Use --api-url or FUNNELSGROVE_API_URL for non-production APIs.
Use --config or FUNNELSGROVE_CONFIG to keep test credentials separate from the default ~/.funnelsgrove/config.json.
