Skip to content

CLI Command Reference

The rouvy-api CLI provides 23 subcommands for interacting with the Rouvy API. All commands support --json for machine-readable output.

Read Commands

Command Description
profile Display user profile (default)
zones Display training zones
activities Display recent activities
activity-stats Weekly activity statistics
apps Display connected apps
career Career progression stats
challenges List available challenges
events List upcoming events
friends Friends summary
routes List favorite routes
raw Fetch raw decoded turbo-stream response

Write Commands

Command Description
set Update user settings (KEY=VALUE pairs)
set-ftp Update FTP
set-height Update height
set-max-hr Update max heart rate
set-profile Update profile fields
set-timezone Update timezone
set-units Update units
set-weight Update weight
set-zones Update zone boundaries
register-challenge Register for a challenge
register-event Register for an event
unregister-event Unregister from an event

Global Flags

All commands support:

--json              Output as JSON instead of formatted text
--verbose           Enable debug logging (shortcut for --log-level DEBUG)
--log-level LEVEL   Set log level (DEBUG, INFO, WARNING, ERROR)