No description
Find a file
Konstantin Fickel ca6b5bbd4d
fix: include dev deps in basedpyright check environment
Use workspace.deps.all instead of workspace.deps.default so that
basedpyright can resolve test dependencies like faker.
2026-02-15 17:33:26 +01:00
.forgejo/workflows ci: split workflow into check and build jobs 2026-02-15 17:33:25 +01:00
.vscode chore: improve dev setup 2025-06-22 12:52:15 +02:00
src/streamd refactor!: rename package from streamer to streamd 2026-02-15 17:33:22 +01:00
tests refactor: rename test/ to tests/ 2026-02-15 17:33:23 +01:00
.envrc build: migrate to devenv 2026-02-15 17:33:24 +01:00
.gitignore build: migrate to devenv 2026-02-15 17:33:24 +01:00
.pre-commit-config.yaml chore: improve dev setup 2025-06-22 12:52:15 +02:00
.python-version refactor!: rename package from streamer to streamd 2026-02-15 17:33:22 +01:00
devenv.lock build: migrate to devenv 2026-02-15 17:33:24 +01:00
devenv.nix build: migrate to devenv 2026-02-15 17:33:24 +01:00
devenv.yaml build: migrate to devenv 2026-02-15 17:33:24 +01:00
flake.lock build: migrate to devenv 2026-02-15 17:33:24 +01:00
flake.nix fix: include dev deps in basedpyright check environment 2026-02-15 17:33:26 +01:00
LICENSE.md docs: license under AGPL 2025-10-12 11:19:03 +02:00
pyproject.toml refactor!: rename package from streamer to streamd 2026-02-15 17:33:22 +01:00
README.md refactor!: rename package from streamer to streamd 2026-02-15 17:33:22 +01:00
renovate.json ci: allow major upgrades from renovate 2026-01-18 17:42:16 +01:00
uv.lock refactor!: rename package from streamer to streamd 2026-02-15 17:33:22 +01:00

strea.md

Strea.md is a personal knowledge management and time-tracking CLI tool. It organizes time-ordered markdown files using @tag annotations, letting you manage tasks, track time, and query your notes from the terminal.

Core Concepts

  • Shards — Sections of markdown files, organized hierarchically by headings. Each shard can contain markers, tags, and nested child shards.
  • Markers — Special @tags like @Task, @Done, @Waiting, or @Timesheet that give shards semantic meaning and place them into dimensions.
  • Dimensions — Classification axes (e.g. task state, project, timesheet) that categorize shards. Some dimensions propagate to child shards.

File Format

Markdown files are named with a timestamp: YYYYMMDD-HHMMSS [markers].md

For example: 20260131-210000 Task Streamd.md

Within files, @-prefixed markers at the beginning of paragraphs or headings define how a shard is categorized.

Commands

  • streamd / streamd new — Create a new timestamped markdown entry, opening your editor
  • streamd todo — Show all open tasks (shards with @Task markers)
  • streamd edit [number] — Edit a stream file by index (most recent first)
  • streamd timesheet — Generate time reports from @Timesheet markers

Configuration

Streamd reads its configuration from ~/.config/streamd/config.yaml (XDG standard). The main setting is base_folder, which points to the directory containing your stream files (defaults to the current working directory).

Usage

Running streamd opens your editor to create a new entry. After saving, the file is renamed based on its timestamp and any markers found in the content.

Running streamd todo finds all shards marked as open tasks and displays them as rich-formatted panels in your terminal.