Documentation
¶
Overview ¶
Package workstream resolves the "workstream" identity that isolates one parallel line of work from another while sharing a single nt store. Several agents (grove worktrees, CI jobs, web/CLI sessions) can run against one store at once; each writer's in-flight TASKS carry a todo.txt `ws:` key so reads can scope to their own line of work, while NOTES stay shared. Both the CLI and the MCP server resolve identity through here so a human's CLI writes and an agent's MCP writes agree when NT_WORKSTREAM is set.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Derive ¶
func Derive() string
Derive infers an identity from the working repo: the checked-out git branch (the natural unit of a parallel line of work, and what grove worktrees map to), falling back to the working-directory basename for non-git or detached-HEAD trees. Returns "" only if even the cwd is unavailable. The result is Normalized so a directory name with spaces stays a valid todo.txt ws: value.
func Env ¶
func Env() string
Env resolves the workstream from the NT_WORKSTREAM environment variable: a literal id, or "auto" → derived from the working repo, or "" when unset (no scoping — behaves exactly as nt did before workstreams). Isolation is opt-in: it activates only once this resolves to a non-empty value. The value is Normalized (whitespace → "-") so it survives the space-delimited todo.txt stamp; when that changes it, a single notice is printed to stderr.
func Normalize ¶ added in v0.22.0
Normalize maps a raw workstream id to its canonical stored form: every whitespace run becomes a single "-", and leading/trailing "-" are stripped. Workstream ids are stamped into the space-delimited todo.txt line as `ws:<id>`, so an id containing whitespace would parse back truncated ("ws:my stream" reads as ws:"my" with "stream" leaking into the task text) — writes and reads must agree on this normalized form. Non-whitespace runes (unicode included) pass through untouched.
func Scope ¶
Scope resolves the effective current workstream for a read: an explicit value (a literal id, or "*" to widen) wins; otherwise the NT_WORKSTREAM environment. Explicit ids are Normalized (whitespace → "-") so reads agree with what writes stamped; "*" passes through Normalize unchanged.
func Visible ¶
Visible decides whether a task in workstream taskWS is visible to a reader currently scoped to `current`. An unscoped reader (current "") or an explicit widen ("*") sees everything. Otherwise a task is visible when it belongs to this workstream OR carries no workstream at all — so the shared human backlog and pre-workstream tasks stay visible to everyone, and only another agent's explicitly-stamped work is hidden.
Types ¶
This section is empty.
Source Files