Skip to main content

Command-line tooling for personal operating system workflows, tools, and automation.

Project description

lifeos-cli

简体中文版

██╗     ██╗███████╗███████╗ ██████╗ ███████╗
██║     ██║██╔════╝██╔════╝██╔═══██╗██╔════╝
██║     ██║█████╗  █████╗  ██║   ██║███████╗
██║     ██║██╔══╝  ██╔══╝  ██║   ██║╚════██║
███████╗██║██║     ███████╗╚██████╔╝███████║
╚══════╝╚═╝╚═╝     ╚══════╝ ╚═════╝ ╚══════╝

lifeos-cli is a terminal-native LifeOS for people who want one structured system for intentions, plans, execution, reflection, and reality.

Why It Exists

Most personal systems fragment life into disconnected tools. Tasks live in one place, calendars in another, notes somewhere else, and actual time spent disappears into scattered logs.

That makes it unnecessarily hard to answer practical questions such as:

  • What did I intend to do?
  • What actually happened?
  • What did I spend time on?
  • Which routines are real versus aspirational?
  • Which people, projects, and priorities am I actually serving?

It gives structure to both sides of life:

  • intention: visions, tasks, habits, and planned events
  • reality: notes, timelogs, completed habit actions, and relationship records

The goal is not just storage, but one CLI interface for self-management, reflection, and automation.

Getting Started

Install or upgrade from PyPI:

uv tool install --upgrade lifeos-cli

Install PostgreSQL support only when you need it:

uv tool install --upgrade "lifeos-cli[postgres]"

Install the optional local Web API dependencies when you want browser or HTTP access backed by the same configured LifeOS database:

uv tool install --upgrade "lifeos-cli[web]"

lifeos-cli supports both SQLite and PostgreSQL.

  • SQLite is the low-friction option for local, single-user setups.
  • PostgreSQL remains the schema-capable backend for managed deployments.

Initialize your local setup:

lifeos init

For local-first use, lifeos init can bootstrap SQLite without requiring a separate database service. Use lifeos init --help for backend-specific defaults and examples.

You can run that step yourself, or ask an agent that can run terminal commands to do it for you.

See the available command surface:

lifeos --help

Start the local Web API server:

lifeos web serve

lifeos web serve does not install, build, or bundle the frontend workspace from PyPI. To serve a built checkout UI from the same process, build web/ and pass its output directory explicitly:

lifeos web serve --static-dir web/dist

If your configured database URL uses PostgreSQL, install or run with both optional extras:

uv run --extra web --extra postgres lifeos web serve

During frontend development, run the Vite app in web/ and proxy API requests to the local Web API:

cd web
npm install
npm run dev

Inspect and adjust runtime preferences:

lifeos config show
lifeos config set preferences.timezone America/Toronto
lifeos config set preferences.language zh-Hans

Common commands:

lifeos schedule show --date 2026-04-13
lifeos task list
lifeos note add "Capture today's key decisions"
lifeos timelog list --date 2026-04-13

For complete CLI usage, workflows, and output conventions, see docs/cli.md.

Agent Use (Recommended)

Any agent runtime that can execute terminal commands and inspect command output can operate the same CLI. That includes Codex, OpenCode, Swival, Claude Code, Cursor, Gemini CLI, OpenClaw, or your own setup.

  • stable grammar: lifeos <resource> <action> [arguments] [options]
  • help-first command model, with --help as the primary command reference
  • identifier-driven discovery flows built around list and show
  • compact summary output for lists and labeled output for record detail views
  • entity-specific primary-key headers such as task_id, vision_id, and event_id

Current Scope

The current system already covers the core building blocks of a practical LifeOS:

  • notes
  • areas
  • tags
  • people
  • visions
  • tasks
  • habits and habit actions
  • events
  • timelogs

Cross-cutting capabilities:

  • a schedule read model that aggregates tasks, habit actions, and planned events into day and range views
  • recurring event expansion and recurring habit cadence support, including on-demand habit-action materialization
  • generic note associations across tasks, visions, events, people, timelogs, and tags
  • persisted runtime configuration for database access plus preferences such as timezone, language, day boundary, week boundary, and vision experience defaults
  • localized CLI help and stable summary-table output for direct human use and agent consumption

Project Policies

License

This project is licensed under the Apache License 2.0. See LICENSE.

Project details


Download files

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

Source Distribution

lifeos_cli-0.16.0.tar.gz (439.7 kB view details)

Uploaded Source

Built Distribution

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

lifeos_cli-0.16.0-py3-none-any.whl (310.1 kB view details)

Uploaded Python 3

File details

Details for the file lifeos_cli-0.16.0.tar.gz.

File metadata

  • Download URL: lifeos_cli-0.16.0.tar.gz
  • Upload date:
  • Size: 439.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for lifeos_cli-0.16.0.tar.gz
Algorithm Hash digest
SHA256 603d990fa2a8d9e67bbc7db8931cd27002383df21a88aa8e2cad640781621fba
MD5 68027d882d0db34039b1daff798a919c
BLAKE2b-256 1e6c863f5c6e2b8a0af76ddde1042304de38bce86d1547483ce00ebe0831e5a7

See more details on using hashes here.

Provenance

The following attestation bundles were made for lifeos_cli-0.16.0.tar.gz:

Publisher: publish.yml on liujuanjuan1984/lifeos-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 lifeos_cli-0.16.0-py3-none-any.whl.

File metadata

  • Download URL: lifeos_cli-0.16.0-py3-none-any.whl
  • Upload date:
  • Size: 310.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for lifeos_cli-0.16.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c5e5d00deba071d447c5e71bd13d975f54de6793a986b92d6dcc3cd1292bb6c0
MD5 f6ab80f2db15b382b7453955021117e3
BLAKE2b-256 19a114ce614ee76553c54e23e4050b91699b67eeed10f6a9e2706889dcb9e284

See more details on using hashes here.

Provenance

The following attestation bundles were made for lifeos_cli-0.16.0-py3-none-any.whl:

Publisher: publish.yml on liujuanjuan1984/lifeos-cli

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

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page