Streaks CLI

Streaks CLI, to manage your calendars and progresses, ant to automate the completion of your tasks on the streaks habit tracking application.

The runners will fetch data from third party services to verify that you have followed your habit and enter it on your dashboard.

Installation

Officially supported on Linux, may work on another platform.

1. Install the following dependencies on your server:

• Python v3 (with pip)
• pipenv (pip install pipenv)

2. Clone the repository:

git clone https://git.chevro.fr/streaks/cli.git

3. You can now install the cli dependencies:

pipenv install

4. Build the executable

pipenv run compile

Go to the Configuration section to edit your config.yml file, then come back here.

Using the CLI

Calendars

# List available calendars
./streaks calendars list
# Add a new calendar
./streask calendars add
    [--name <name>] [--enable] [--disable]
    [--disable-reminders] [--disable-congrats]
    [--agenda <comma separated list of seven true/false values>]
# Edit a calendar
./streaks calendars edit <calendar_id>
    [--name <name>] [--enable] [--disable]
    [--disable-reminders] [--enable-reminders]
    [--disable-congrats] [--enable-congrats]
    [--agenda <comma separated list of seven true/false values>]
# Delete a calendar
./streaks calendars delete <calendar_id>

Progresses

# List available progresses
./streaks progresses list
# Add a new progress
./streaks progresses add
    [--name <name>] [--enable] [--disable]
    [--goal <number>] [--unit <daily|weekly|monthly|yearly>]
# Edit a progress
./streaks progresses edit <progress_id>
    [--name <name>] [--enable] [--disable]
    [--goal <number>] [--unit <daily|weekly|monthly|yearly>]
# Delete a progress
./streaks progresses delete <progress_id>

Runners

./streaks runners # Run all runners
    [--service <service name>] # Run a specific runner
    [--force] # When used with --service, run the specified service even if it is disabled.
    [--reset] # Reset service(s) data (remove everything)
    [--start <ISO date>] # Will run the service for every day from the specified date to today

Configuration

⚠️ Some services may ask you for your credentials to third party services. In these cases you need to be very careful with your config.yml file. ⚠️

---

The minimal config.yml file should look like this:

instance: "https://streaks.chevro.fr"
api_key: "your_api_key"
services:
  <The services configuration (detailed below)>

instance

This is the address of the Streaks instance you are using.

api_key

This is your Streaks API key, these are generated from the Streaks application and allow the runner to mark your successes.

services

This is an optionnal section that you need to configure only if you want to use the runners (fetch a day status from a third-party service)

The services section includes the configuration of each third party service you will use. The syntax will look like :

services:
- type: duolingo
  name: "🦜 Duolingo"
  enable: true
  goal: 15xp
  calendars:
  - '63c028aa405c3470bac95040'

But each service requires a different configuration, here is a list of the built-in services

Built-in services

Here is a list of supported services, each service has its own README which contains its configuration instructions for the config.yml file.

• Duolingo Expand your streak if you have reached your daily goal on Duolingo.
• Strava Expand your streak if you have made an activity on Strava.
• Gitlab Expand your streak if you have committed at least once today.
• Brilliant Expand your streak if you have completed a daily challenge on Brilliant.