refactor!: rename package from streamer to streamd

- Rename src/streamer/ to src/streamd/
- Update all internal imports
- Update pyproject.toml project name and entry point
- Update README branding (Streamer -> Strea.md)
- Switch from pyright to basedpyright
- Bump requires-python to >=3.13

2026-02-15 17:33:22 +01:00

1.8 KiB

Raw Blame History

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.

1.8 KiB Raw Blame History