Expand description
Output formatting utilities for nicely rendered command blocks
Provides “timeline” format: a width-independent, lossless output format that works in TTY, tmux, SSH, CI, and logs.
Core concepts:
│prefix → tool metadata (timeline marker)$→ executed command (virtual or user command)- No prefix → program output (stdout/stderr)
- Result marker (
✓/✗) appears after output
Structs§
- Finish
Block Options - Options for creating a finish block
- Isolation
Metadata - Parsed isolation metadata
- Start
Block Options - Options for creating a start block
Constants§
- FAILURE_
MARKER - Failure result marker
- SPINE
Deprecated - Alias for backward compatibility
- SUCCESS_
MARKER - Success result marker
- TIMELINE_
MARKER - Timeline marker character (formerly called “spine”) Used to prefix metadata lines in the timeline format
Functions§
- create_
command_ line - Create a command line with $ prefix
- create_
empty_ spine_ line Deprecated - Alias for backward compatibility
- create_
empty_ timeline_ line - Create an empty timeline line (just the timeline marker character)
- create_
finish_ block - Create a finish block for command execution using timeline format
- create_
spine_ line Deprecated - Alias for backward compatibility
- create_
start_ block - Create a start block for command execution using timeline format
- create_
timeline_ line - Create a metadata line with timeline marker prefix
- create_
timeline_ separator - Create a separator line between virtual commands and user commands
- create_
virtual_ command_ block - Create a virtual command block for setup steps (like docker pull) Virtual commands are displayed separately in the timeline to show intermediate steps that the tool performs automatically
- create_
virtual_ command_ result - Create a result marker line for a virtual command
- escape_
for_ links_ notation - Escape a value for Links notation Smart quoting: uses single or double quotes based on content
- format_
duration - Format duration in seconds with appropriate precision
- format_
value_ for_ links_ notation - Format a serde_json::Value for Links notation
- generate_
isolation_ lines - Generate isolation metadata lines for timeline format
- get_
result_ marker - Get the result marker based on exit code
- parse_
isolation_ metadata - Parse isolation metadata from extra lines