CLI tool for accessing Oura Ring data.

Appreciate the fine elegance of the terminal braille charts

# Clone the repository
git clone <repository-url>
cd ouracli

# Install dependencies
task py:install

Set up your Oura API personal access token:

cp secrets/oura.env.example secrets/oura.env
# Edit secrets/oura.env and add your token

# Get daily activity data
ouracli activity "7 days" --json

# Get sleep data for yesterday
ouracli sleep yesterday

# Get all data for today
ouracli all today --json

# Available output formats: tree (default), json, dataframe, markdown, html
ouracli sleep today --markdown

For AI agents and LLMs, use the --ai-help flag to get comprehensive usage instructions in structured formats:

# Get usage guide in markdown format (default)
ouracli --ai-help

# Get usage guide in JSON format for programmatic parsing
ouracli --ai-help --ai-help-format json

This follows the dashdash-spec v0.2.0 convention for providing machine-readable CLI documentation.

• activity - Daily activity data
• sleep - Daily sleep data
• readiness - Daily readiness scores
• heartrate - Heart rate time series
• workout - Workout summaries
• session - Session data
• spo2 - Daily SpO2 data
• stress - Daily stress data
• personal-info - Personal information
• rest-mode - Rest mode periods
• all - All available data

Flexible date range options:

• today - Current day
• yesterday - Previous day
• 1 day or 1 days - Today
• 2 days - Today and yesterday
• n days - Last n days
• n weeks - Last n weeks
• n months - Last n months
• YYYY-MM-DD + period - Start date plus period (e.g., 2024-01-01 7 days)

# Format code
task py:fmt

# Lint code
task py:lint

# Type check
task py:type

# Run tests
task test

# Run tests with coverage
task test:coverage

# Pre-commit checks
task check

MIT