mywhoop

KO | EN

gitlite — search

#javascript #hacktoberfest #react #llm #deep-learning #linux #docker #macos #awesome #cli #vue #security #ios #open-source

(★ 77)

A tool for gathering and retaining your own Whoop data.

mywhoop Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/karl-cardenas-coding/mywhoop)
[![Go Reference](https://pkg.go.dev/badge/github.com/karl-cardenas-coding/mywhoop.svg)](https://pkg.go.dev/github.com/karl-cardenas-coding/mywhoop)
[![Go Report Card](https://goreportcard.com/badge/github.com/karl-cardenas-coding/mywhoop)](https://goreportcard.com/report/github.com/karl-cardenas-coding/mywhoop)
[![codecov](https://codecov.io/github/karl-cardenas-coding/mywhoop/graph/badge.svg?token=ZHEE3T4HUG)](https://codecov.io/github/karl-cardenas-coding/mywhoop)

# MyWhoop

MyWhoop is a tool for gathering and retaining your Whoop data from the [Whoop API](https://developer.whoop.com/api).

## Overview

MyWhoop is a tool intended to help you take ownership of your Whoop data. You can use MyWhoop to download all your Whoop data. You can also use MyWhoop as a server to automatically download your new Whoop data daily. MyWhoop is designed to be deployed on your own machine or server. MyWhoop supports the following features:

- 🔐 **Login**: A simple interface to log into the Whoop developer portal and save an authentication token locally. The token is required to interact with the Whoop API.
- 🗄️ **Server**: Automatically download your Whoop data daily and save it to a local file or export it to a remote location.
- 📬 **Notifications**: Receive notifications when new data is available or when an error occurs.
- 💾 **Data Export**: Export your Whoop data as JSON, Excel, or into a local SQLite database, with optional upload to an S3 bucket.
- 🗂️ **Extensions**: Data exporters and notification services can be extended to support additional use cases. Check out the [Extensions](#extensions-️) section to learn more.
- 📦 **No Dependencies**: MyWhoop is available as a stand-alone binary or Docker image. No additional software is required to get started.

## Get Started 🚀

Please check out the [Getting Started](/docs/get-started.md) guide to get started with MyWhoop.

### Server Mode Setup 🗄️

To set up MyWhoop in server mode, use the [Setup Server Mode](/docs/get-started-server-guide.md) guide.

## Commands

MyWhoop supports the following commands and global flags:

- [Dump](#dump) - Download your Whoop data and save it to a local file.
- [Login](#login) - Authenticate with the Whoop API and save the authentication token locally.
- [Help](#help) - Display help information for MyWhoop.
- [Server](#server) - Automatically download your Whoop data daily and save it to a local file or export it to a remote location.
- [Version](#version) - Display the version of MyWhoop.

#### Global Flags

| Long Flag       | Short Flag | Description                                                                                   | Required | Default           |
| --------------- | ---------- | --------------------------------------------------------------------------------------------- | -------- | ----------------- |
| `--config`      | -          | The file path to the MyWhoop [configuration file](./docs/configuration_reference.md).         | No       | `~/.mywhoop.yaml` |
| `--credentials` | -          | The file path to the Whoop credentials file that contains a valid Whoop authentication token. | No       | `token.json`      |
| `--debug`       | `-d`       | Modify the output logging level.                                                              | No       | `INFO`            |

> [!IMPORTANT]
> For more information on the MyWhoop configuration file, refer to the [Configuration Reference](./docs/configuration_reference.md) section.

### Dump

The dump command downloads **all your Whoop data** and saves it to a local file. For more advanced configurations, use a Mywhoop configuration file. Refer to the [Configuration Reference](./docs/configuration_reference.md) section for more information.

```bash
mywhoop dump
```

#### Flags

| Long Flag    | Short Flag | Description                                                                                                                                                                                                                                                                                                       | Required | Default   |
| ------------ | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | --------- |
| `--location` | `-l`       | The location to save the Whoop data file.                                                                                                                                                                                                                                                                         | No       | `./data/` |
| `--filter`   | `-f`       | Specify a filter string to filter the data. For example to download all the data from January 2024 `start=2024-01-01T00:00:00.000Z&end=2024-01-31T00:00:00.000Z`. You can learn more about the filter syntax in the Whoop API [Pagination](https://developer.whoop.com/docs/developing/pagination) documentation. | No       | `""`      |
| `--output`  | `-o`        | The output format. Supported types are `json`, `xlsx`, or `sqlite`.  | No       | `json`    |

#### Filter

You can filter the data using the `--filter` flag. The filter flag expects a string that follows the Whoop API [Pagination](https://developer.whoop.com/docs/developing/pagination) filter syntax. A `start` value is required, the `end` value is optional. For example, to download all the data from January 2024, use the following filter string.

```bash
mywhoop dump --filter "start=2024-01-01T00:00:00.000Z&end=2024-01-31T00:00:00.000Z"
```

> [!TIP]
> Wrap the filter string in quotes to prevent the shell from interpreting the `&` character as a command separator.

You can omit the `end` value to download all the data from the specified `start` date to the current date. For example, use the following filter string to download all the data from March 2022 to the current date.

```bash
mywhoop dump --filter "start=2022-03-01T00:00:00.000Z"
```

If you specify an invalid filter string, Whoop will normaly ignore the filter and return all the data.

> [!IMPORTANT]
> MyWhoop has exponential backoff and retries logic built in for the Whoop API. If the API is down or the request fails, MyWhoop will retry the request. Whoop has an [API rate limit of 100 requests per minute](https://developer.whoop.com/docs/developing/rate-limiting). If the rate limit is exceeded, MyWhoop will attempt to retry the request after a delay for up to a maximum of 5 minutes. If the request fails after 5 minutes, the application will exit with an error. If the Whoop API rejects the authentication token, the application will exit with an error.

### Login

The login command is used to authenticate with the Whoop API and save the authentication token locally. The command will set up a local static HTTP server hosting a simple website to handle the OAuth2 handshake with the Whoop API and save the token to a local file.

```bash
mywhoop login
```

#### Flags

| Long Flag        | Short Flag | Description                                                                                                                             | Required | Default                           |
| ---------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------- | -------- | --------------------------------- |
| `--no-auto-open` | `-n`       | By default, the login command will automatically open a browser window to the Whoop login page. Use this flag to disable this behavior. | No       | False                             |
| `--port`         | `-p`       | The port to use for the local HTTP server.                                                                                              | No       | `8080`                            |
| `--redirect-url` | `-r`       | The redirect URL to use for the OAuth2 handshake.                                                                                       | No       | `http://localhost:8080/redirect`. |

## Server

The server command automatically downloads your Whoop data daily. If specified through a configuration file, the server saves or exports the data to a local file or a remote location. The server is designed to be started as a background process and will automatically download your Whoop data daily. The command will refresh the Whoop authentication token every 45 minutes and update the local token file. The Whoop API is queried precisely every 24 hours from when the server is started.

> [!IMPORTANT]
> A Whoop authentication token is required to use the server command. The server will attempt to refresh the token immediately upon to startup. If the token is invalid or expired, the server will exit with an error. Use the [`login`](#login) command to authenticate with the Whoop API and save the token locally. The reason for the immediate refresh is to support use cases where the server is started and stopped, such as system reboots or server restarts.

```bash
mywhoop server
```

Use a MyWhoop configuration file for more advanced configurations. For more information, refer to the [Configuration Reference](./docs/configuration_reference.md) section.

```bash
mywhoop server --config /opt/mywhoop/config.yaml
```

## Version

The version command is used to display the version of MyWhoop. The version command checks for the latest version of MyWhoop and displays the current version. If a new version is available, the command will notify you.

```bash
mywhoop version
```

```
2024/07/06 10:50:29 INFO mywhoop v0.3.3
```

## Extensions 🗂️

MyWhoop supports extensions for data exporters and notification services. Exporters are used to export your Whoop data to a remote location, such as an S3 bucket or to a unique data store. Notification services are used to send notifications when new data is available or when an error occurs. Extensions are configured in the MyWhoop configuration file. For more information, refer to the [Configuration Reference](./docs/configuration_reference.md) section.

### Data Exporters

| Name        | Description                                                                                                                                   | Configuration                                                  |
| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- |
| File        | The default exporter. Saves the Whoop data to a local file in `json`, `xlsx`, or `sqlite` format.                                             | [File Exporter](./docs/configuration_reference.md#file-export) |
| SQLite      | Writes your Whoop data into a local SQLite database (one row per sleep, cycle, recovery, and workout), upserting on each run so history accumulates. | [File Exporter](./docs/configuration_reference.md#file-export) |
| AWS S3      | The [AWS S3](https://aws.amazon.com/s3/) exporter uploads your Whoop data to an S3 bucket as `json`, `xlsx`, or `sqlite`.                     | [AWS S3 Exporter](./docs/configuration_reference.md#s3-export) |
| S3 + SQLite | Maintains a local SQLite database and uploads the full file to S3 after every run. Enable bucket versioning if you want historical snapshots. | [AWS S3 Exporter](./docs/configuration_reference.md#s3-export) |

### Notification Services

| Name   | Description                                                                                           | Configuration                                            |
| ------ | ----------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
| stdout | The stdout notification is the default notification mechanism. Output is sent to the console.         | [Stdout](./docs/configuration_reference.md#notification) |
| Ntfy   | Use the [Ntfy](https://ntfy.sh/) notification service to send notifications to your phone or desktop. | [Ntfy](./docs/configuration_reference.md#ntfy)           |

mywhoop

mywhoop Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

mywhoop

mywhoop Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README