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?

The CLI (blktxt ingest, push, etc.) works directly against your database with zero accounts, nothing to sign into. The web lens (blktxt serve) does ask you to sign up on first visit (instant, local, and self-contained, no third party involved) since it's a login-gated app either way. The hosted version works the same way, just running on infrastructure you don't have to manage: each account's notes are isolated from every other account's. Want to see it first? try it hosted with no signup at all: drop a file in and it gives you a private, expiring scratch workspace you can claim into a real account later if you want to keep it.

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.