CLICommands
tour
snug tour <COMMAND>Product tour and onboarding progress tracking.
Subcommands
| Command | What it does |
|---|---|
create | Create a tour definition from a JSON file |
list | List tour definitions |
get | Get a tour definition |
update | Update a tour definition |
delete | Delete a tour definition |
status | Show tour progress for a user |
event | Record a progress event |
flag-set | Set or clear UI completion flags |
reset | Reset user progress |
analytics | Show funnel analytics |
Run snug tour <command> --help for that command's own options.
The global options apply everywhere.
Examples
snug tour create --file new-user-setup.json
snug tour list
snug tour list --status active --query setup --page 1 --page-size 20
snug tour get --tour CDqLNRRwSXuZRPuZqBpj
snug tour update --tour CDqLNRRwSXuZRPuZqBpj --status active
snug tour update --tour CDqLNRRwSXuZRPuZqBpj --steps-file steps.json
snug tour delete --tour CDqLNRRwSXuZRPuZqBpj
snug tour status usr_01HX --tour CDqLNRRwSXuZRPuZqBpj
snug tour event --tour CDqLNRRwSXuZRPuZqBpj --event-type step_completed --step step_profile
snug tour flag-set --tour CDqLNRRwSXuZRPuZqBpj --user usr_01HX --flag profile_completed
snug tour reset --tour CDqLNRRwSXuZRPuZqBpj
snug tour reset --tour CDqLNRRwSXuZRPuZqBpj --user usr_01HX --scope user
snug tour analytics --tour CDqLNRRwSXuZRPuZqBpj --version 4
snug tour analytics --tour CDqLNRRwSXuZRPuZqBpj --window 2026-06-16Next
- tour guide - what the service does and when to reach for it.
- API reference - every endpoint these commands call.
- CLI reference - global options, output modes, and exit codes.