A command-line interface for accessing your Oura Ring data, built with TypeScript and Bun.

curl -fsSL https://raw.githubusercontent.com/lertsoft/oura-ring-cli/main/install.sh | sh

Download the appropriate binary for your platform from the Releases page:

Then make it executable and move to your PATH:

chmod +x oura-darwin-arm64
sudo mv oura-darwin-arm64 /usr/local/bin/oura

Requires Bun runtime:

cd oura-ring-cli
bun install
bun run build
./oura --help

Visit the Oura Developer website to create an application and get your Client ID and Secret.

Important: Set your redirect URI to http://localhost:8080/callback

Run the interactive authentication:

oura auth

The CLI will guide you through:

• Entering your Client ID
• Entering your Client Secret
• Opening your browser to authorize the app

Your credentials and tokens are saved to ~/.config/oura-cli/config.json.

Run the interactive data explorer:

oura get

This shows a menu of all available data types organized by category:

📊 Oura Ring Data Explorer

? What data would you like to get?
👤 Personal
❯ Personal Info
  Ring Configuration

😴 Sleep
  Daily Sleep
  Sleep Details
  Optimal Bedtime

🏃 Activity
  Daily Activity
  Workouts
  Sessions

❤️ Heart & Body
  Heart Rate
  Blood Oxygen (SpO2)
  Cardiovascular Age
  VO2 Max

🧘 Wellness
  Readiness
  Stress
  Resilience
  Rest Mode

For automation or scripting, use direct commands:

# Personal information
oura get personal

# Sleep data with date range
oura get sleep --start 2024-01-01 --end 2024-01-07

# Activity data (short flags)
oura get activity -s 2024-01-01 -e 2024-01-07

# Other commands
oura get readiness
oura get heartrate
oura get workout
oura get spo2
oura get sleep-details
oura get sessions
oura get sleep-times
oura get stress
oura get resilience
oura get cv-age
oura get vo2-max
oura get ring-config
oura get rest-mode
oura get tags

Build binaries for all supported platforms:

bun run build:all

This creates binaries in the dist/ folder:

• dist/oura-darwin-arm64 (macOS Apple Silicon)
• dist/oura-darwin-x64 (macOS Intel)
• dist/oura-linux-x64 (Linux x64)
• dist/oura-linux-arm64 (Linux ARM64)
• dist/oura-windows-x64.exe (Windows x64)

oura-ring-cli/
├── package.json
├── tsconfig.json
├── install.sh              # One-line installer script
├── src/
│   ├── index.ts            # Entry point, CLI setup
│   ├── commands/
│   │   ├── auth.ts         # Interactive OAuth authentication
│   │   └── get.ts          # Interactive data explorer + commands
│   ├── api/
│   │   ├── client.ts       # OuraClient with fetch + token refresh
│   │   └── types.ts        # TypeScript interfaces for API responses
│   ├── auth/
│   │   └── oauth.ts        # OAuth2 flow implementation
│   └── config/
│       └── config.ts       # Configuration management
└── README.md

Configuration is stored in ~/.config/oura-cli/config.json:

{
  "client_id": "...",
  "client_secret": "...",
  "access_token": "...",
  "refresh_token": "...",
  "expiry": "2024-01-01T00:00:00.000Z"
}

MIT