ascii-progress-and-spinner
npx machina-cli add skill partme-ai/full-stack-skills/ascii-progress-and-spinner --openclawWhen to use this skill
CRITICAL TRIGGER RULE
- Use this skill ONLY when the user explicitly mentions the exact skill name:
ascii-progress-and-spinner.
Trigger phrases include:
- "ascii-progress-and-spinner"
- "use ascii-progress-and-spinner"
- "用 ascii-progress-and-spinner 生成 ASCII 进度条"
- "使用 ascii-progress-and-spinner 做 spinner / loading"
Boundary
- Do not integrate a specific UI framework; output styles + refresh rules + fallback protocol + examples.
- Must cover:
- determinate progress bars
- indeterminate spinners
- non-TTY / redirected-output fallback (log lines, no carriage-return updates)
How to use this skill
Inputs
- mode (determinate | indeterminate)
- width (default 40)
- showPercent (default true)
- showEta (optional)
- multiTask (optional)
- colorMode (none | ansi256, default none)
Outputs (required)
- progressBarStyles (>= 3)
- spinnerStyles (>= 2)
- renderRules (TTY single-line refresh vs logLines)
- fallbackRules (non-interactive / redirected output)
Recommended render rules
- TTY (interactive): single-line refresh (overwrite previous line), avoid log spam
- Non-TTY (logs): print log lines (no overwrite). Each line may include task name + percent.
Script
scripts/demo.py: local demo for progress bar + spinner shapes
Examples
examples/styles.md
Quality checklist
- Fixed width (percent field is fixed-width to avoid jitter)
- Log mode is grep-friendly (no overwrite)
- ASCII-only defaults are available (avoid ambiguous-width Unicode)
Keywords
English: ascii-progress-and-spinner, progress bar, spinner, loading, tty, non-interactive, log output, ascii 中文: ascii-progress-and-spinner, 进度条, Spinner, Loading, 终端, TTY, 日志降级, ASCII
Source
git clone https://github.com/partme-ai/full-stack-skills/blob/main/skills/ascii-progress-and-spinner/SKILL.mdView on GitHub Overview
ascii-progress-and-spinner designs copy-pasteable ASCII progress bars and spinners for CLI UX. It covers determinate and indeterminate modes, supports TTY single-line refresh, and includes a non-interactive log fallback. The skill defines style specs and rules (progressBarStyles, spinnerStyles, renderRules, fallbackRules) to keep CLI feedback consistent and grep-friendly.
How This Skill Works
Developers supply inputs like mode (determinate|indeterminate), width (default 40), showPercent (default true), showEta, multiTask, and colorMode (none|ansi256). The skill then outputs at least three progressBarStyles, two spinnerStyles, plus renderRules for TTY vs logLines and fallbackRules for non-interactive output. A local demo script (scripts/demo.py) and examples/styles.md illustrate copy-pasteable shapes.
When to Use It
- When building a CLI tool that must show a determinate progress bar with a fixed width and percent.
- When you need an indeterminate spinner during IO-bound waits in a TTY session.
- When output may be redirected to logs and you need non-overwriting log lines.
- When you require copy-pasteable, style-consistent ASCII specs across teams.
- When tracking multiple tasks concurrently with a multiTask option.
Quick Start
- Step 1: Configure inputs: mode, width, showPercent, showEta, multiTask, colorMode.
- Step 2: Generate outputs: progressBarStyles >= 3, spinnerStyles >= 2, renderRules, and fallbackRules.
- Step 3: Run the local demo (scripts/demo.py) to preview shapes and consult examples/styles.md for ready-made specs.
Best Practices
- Fix the progress bar width to avoid jitter; keep a fixed width for the percent field.
- Provide separate renderRules for TTY refresh vs logLines; do not mix carriage returns in logs.
- Offer ASCII-only defaults for maximum compatibility, and optional ANSI color via colorMode.
- Make ETA optional and only render when showEta is enabled to avoid clutter.
- Ensure log output is grep-friendly by using task names and percent per line in non-TTY mode.
Example Use Cases
- A Python CLI downloader showing a 40-char determinate progress with percent and ETA.
- An installer showing an indeterminate spinner during package extraction.
- A data-ETL job that logs each task with a name and percent when redirected to a file.
- A multi-task build tool displaying several tasks progress in one line.
- A docs/examples page that demonstrates copy-pasteable style specs in examples/styles.md.
