help

Getting started.

A quick FAQ for evaluating blk/txt before you install anything. For in-app help once you're running it (syncing, workspaces, CLI reference), see the docs inside the app itself.

Quickstart

zsh
# pick a shape, ingest, and serve
$ blktxt init --preset incidents
$ blktxt ingest ~/logs
$ blktxt serve  # http://127.0.0.1:5000

FAQ

Do I need an account?

Not if you self-host: the CLI and local web lens work with zero accounts, nothing to sign into. If you'd rather not run infrastructure, the hosted version needs a login — each account's notes are isolated from every other account's.

Where is my data stored?

In a local SQLite database, compiled from your plain-text source files. The database is always derived and rebuildable; your text files are the source of truth.

Is my data private?

Self-hosted: it never leaves your machine. Hosted: your account's notes are scoped to you only — no other account can read or write them.

What can it parse?

Markdown, logs, ticket notes, CSV/YAML-like text — anything text-shaped and roughly dated. See About for how parsing and entity extraction work.