Skip to main content

studylife-cli

A command-line client for StudyLife, the self-hosted study organizer. Manage notes, sessions, course goals, and webhooks from your terminal - scripts and shells welcome.

Install

pip install git+https://github.com/lukislp/studylife-cli

(PyPI publishing is planned; until then, install straight from GitHub.)

Register the CLI on your instance

studylife-cli connects to your StudyLife instance through the same add-on mechanism any third-party integration uses - there is no special-cased server support to set up. Register it once via your own studylife-developers portal:

  1. Open your studylife-developers instance and go to Register new add-on.
  2. Fill in:
    • Client ID: studylife-cli
    • Allowed redirect URIs (one per line):
      http://127.0.0.1:8765/callback
      http://127.0.0.1:8766/callback
      http://127.0.0.1:8767/callback
      http://127.0.0.1:8768/callback
      
    • Scopes: whichever of notes/sessions/course-goals/timer/courses/study-programs/webhooks you want the CLI to be able to use.
  3. Save.

Log in

studylife login https://studylife.example.com

This opens your browser to approve the connection, then stores a scoped API key locally at ~/.config/studylife-cli/credentials.json (owner-readable only, on POSIX).

Usage

studylife notes list
studylife notes search "exam"
studylife notes create "Title" "Content" --course-id 1

studylife sessions list
studylife sessions history --days 7
studylife sessions create 2026-08-30T14:00:00 --end 2026-08-30T15:00:00 --title "Focus block"

studylife goals list
studylife goals set 1 --target-ects 5

studylife timer
studylife courses list
studylife programs list
studylife programs get 1

studylife webhooks list
studylife webhooks create https://example.com/hook session.completed
studylife webhooks delete 3

Add --json to any command for machine-readable output:

studylife notes list --json | jq '.[] | .title'

Development

uv sync
uv run pytest
uv run ruff check .
uv run ruff format --check .

License

AGPL-3.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

studylife_cli-1.3.0.tar.gz (44.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

studylife_cli-1.3.0-py3-none-any.whl (28.8 kB view details)

Uploaded Python 3

File details

Details for the file studylife_cli-1.3.0.tar.gz.

File metadata

  • Download URL: studylife_cli-1.3.0.tar.gz
  • Upload date:
  • Size: 44.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for studylife_cli-1.3.0.tar.gz
Algorithm Hash digest
SHA256 9d52b82ff9f1470912270f8b689c2e8ea5959fc0992461b7b49b22fd8c42bebf
MD5 4f7f0ffe56a2728499c3e5b2a74886d3
BLAKE2b-256 a61447d912a3919fbaac9303d876990e6e321782af33372c437d3c03aeb7acca

See more details on using hashes here.

Provenance

The following attestation bundles were made for studylife_cli-1.3.0.tar.gz:

Publisher: ci.yml on lukislp/studylife-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file studylife_cli-1.3.0-py3-none-any.whl.

File metadata

  • Download URL: studylife_cli-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 28.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for studylife_cli-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ac10daa008ea80772aeeda3ac1c240c2b18a5b7d04b5db75a4427a92be2e0b37
MD5 a819f2b946c9d181273876b4b490e7ba
BLAKE2b-256 befa776294d8847c7a578cddc1ff41a9c375a00b65efdc18ec26e9d91976fb9e

See more details on using hashes here.

Provenance

The following attestation bundles were made for studylife_cli-1.3.0-py3-none-any.whl:

Publisher: ci.yml on lukislp/studylife-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

1.8.2

2 files

1.8.1

2 files

1.8.0

2 files

1.7.0

2 files

1.6.0

2 files

1.5.0

2 files

1.4.0

2 files

This release

1.3.0 This release

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page