docs: add installation instructions for .deb, binary, and Nix
All checks were successful
Continuous Integration / Lint, Check & Test (push) Successful in 1m32s
Continuous Integration / Build Package (push) Successful in 2m15s

Document the three installation methods:
- Debian/Ubuntu .deb package with shell completions
- Statically-linked binary for any Linux system
- Nix flake and Home Manager module
This commit is contained in:
Konstantin Fickel 2026-04-02 22:56:40 +02:00
parent dfd359802f
commit ae539f01c9
Signed by: kfickel
GPG key ID: A793722F9933C1A5

View file

@ -4,6 +4,39 @@
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. 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.
## Installation
### Debian/Ubuntu (.deb package)
Download and install the latest release:
```bash
wget https://git.konstantinfickel.de/kfickel/streamd/releases/download/vX.Y.Z/streamd_X.Y.Z_amd64.deb
sudo dpkg -i streamd_X.Y.Z_amd64.deb
```
This includes shell completions for bash, zsh, and fish.
### Static Binary
Download the statically-linked binary:
```bash
wget https://git.konstantinfickel.de/kfickel/streamd/releases/download/vX.Y.Z/streamd-X.Y.Z-linux-x86_64
chmod +x streamd-X.Y.Z-linux-x86_64
sudo mv streamd-X.Y.Z-linux-x86_64 /usr/local/bin/streamd
```
### Nix
Using the flake directly:
```bash
nix run git+https://git.konstantinfickel.de/kfickel/streamd
```
Or add to your NixOS/Home Manager configuration using the provided `homeManagerModules.default`.
## Core Concepts ## Core Concepts
- **Shards** — Sections of markdown files, organized hierarchically by headings. Each shard can contain markers, tags, and nested child shards. - **Shards** — Sections of markdown files, organized hierarchically by headings. Each shard can contain markers, tags, and nested child shards.