OnRamp CLI

Manage OnRamp apps, funnels, segments, keys, integrations, and analytics from a terminal or coding agent.

For coding agents

The OnRamp SDK records milestone events. Funnel definitions are separate from SDK instrumentation, but they are not dashboard-only. If you are asked to add a funnel, complete both parts of the task: add the correct SDK step() calls, then create and verify the ordered funnel with this CLI.

Run the CLI without installing it globally:

npx --yes @onramp-sdk/cli@latest whoami

If it is not connected, start browser authorization and ask the human to approve it:

npx --yes @onramp-sdk/cli@latest login

Never ask a user to paste an organization token into chat. For CI or an already configured environment, the CLI also reads ONRAMP_TOKEN.

Create and verify a funnel

List projects if you do not already have the project ID:

npx --yes @onramp-sdk/cli@latest apps list

Create or replace a funnel whose ordered steps exactly match the SDK calls in the product:

npx --yes @onramp-sdk/cli@latest funnels create \
  --app-id <project-id> \
  --name "Activation" \
  --steps '[{"step_name":"account_created","display_label":"Account created"},{"step_name":"first_action_done","display_label":"First action"}]'

npx --yes @onramp-sdk/cli@latest funnels get Activation --app-id <project-id>

For longer definitions, pass a JSON file with --steps @path/to/funnel.json.

More commands

npx --yes @onramp-sdk/cli@latest --help
npx --yes @onramp-sdk/cli@latest funnels --help
npx --yes @onramp-sdk/cli@latest insights --help

Output is JSON by default so agents and scripts can parse it reliably. Pass --pretty for human-readable output.

Read the complete OnRamp CLI guide for authentication, permissions, apps, keys, funnels, segments, integrations, and analytics commands.

Requires Node.js 18 or later.