termpulse-cli 0.1.0

CLI for native terminal progress indicators — wrap commands, pipe progress, detect capabilities.
termpulse-cli-0.1.0 is not a library.

termpulse-cli

Crates.io docs.rs License

CLI for native terminal progress indicators via OSC 9;4.

Installation

cargo install termpulse-cli

Quick Start

# Set progress to 50%
termpulse set 50 -l "Building"

# Indeterminate spinner
termpulse start -l "Compiling"

# Wrap a command with automatic progress
termpulse wrap -- cargo build --release

# Pipe with progress tracking
curl -sL https://example.com/file.tar.gz \
  | termpulse pipe --total 104857600 -l "Downloading" \
  > file.tar.gz

# Signal completion
termpulse done -l "Build complete"

# Detect terminal capabilities
termpulse detect --json

Commands

Command Description
set <percent> [-l label] Set progress percentage (0-100)
start [-l label] Start indeterminate progress
done [-l label] Signal success
fail [-l label] Signal failure
wrap -- <command...> Wrap a shell command with progress
pipe [--total N] [--lines] Pipe stdin to stdout with progress
clear Clear the progress indicator
detect Show terminal capabilities
completions <shell> Generate shell completions

Shell Completions

# Bash
termpulse completions bash > ~/.local/share/bash-completion/completions/termpulse

# Zsh
termpulse completions zsh > ~/.zfunc/_termpulse

# Fish
termpulse completions fish > ~/.config/fish/completions/termpulse.fish

Part of termpulse

This is the CLI binary. For the Rust library, see termpulse. For the low-level no_std core, see termpulse-core.

License

MIT