Expand description
Prepare finite tasks, then execute shell commands in managed process groups.
Modules§
- report
- Where a run’s progress, warnings and task output go. The runner and the
cache report events; the CLI installs a sink that renders them for the
output style. Without one, events print as
qk:status lines on stderr.
Macros§
- status
- Reports a
qk:warning to the installed sink; by default it is written to stderr in one write, so task processes sharing stderr cannot split it.
Structs§
- Capture
- Framed stdout/stderr chunks, optionally stored on disk without buffering the task’s log, and shown as the task’s display asks.
- Decoration
- Nx’s per-command
prefix,prefixColor,colorandbgColor. - Node
Path - The runner’s Node selection, resolved only when a command starts.
- Prepared
Task - Recorded
Log - Ordered, stream-tagged frames retained for run history.
- Recording
- An external syscall recorder wrapping each command, with separate trace files.
Enums§
- Confinement
- How a sandboxed task’s commands are held to what it declares.
- Display
- How a task’s output reaches the terminal, after Nx’s output styles.
- Outcome
- Output
Style - The output styles qk renders.
- Shown
- How a task ended, for the header of held output.
Constants§
- MAX_
LOG_ BYTES - Maximum framed bytes retained for an execution, independent of result caching.
Functions§
- environment
- Read dotenv files into a child environment without changing process globals. Existing process variables win over .env.local, which wins over .env.
- execute
- execute_
captured - prepare
- read_
capture - replay
- Shows a recorded log as a cache hit.
- shell
- A command running
textin the shell tasks run in:/bin/shon Unix,cmd.exeon Windows.