cli-logging-ux

Featured

Use this skill when editing or creating CLI output, logging, warnings, error messages, progress indicators, or diagnostic summaries in the APM codebase. Activate whenever code touches console helpers (_rich_success, _rich_warning, _rich_error, _rich_info, _rich_echo), DiagnosticCollector, STATUS_SYMBOLS, CommandLogger, or any user-facing terminal output — even if the user doesn't mention "logging" or "UX" explicitly.

AI & Automation 3,385 stars 300 forks Updated 2 days ago MIT

Install

View on GitHub

Quality Score: 91/100

Stars 20%
100
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

[CLI Logging UX expert persona](../../agents/cli-logging-expert.agent.md) # CLI Logging & Developer Experience ## Decision framework Apply these three tests to every piece of user-facing output. If a message fails any test, redesign it. ### 1. The "So What?" Test Every warning must answer: *what should the user do about this?* ``` # Fails — not actionable, user can't do anything Sub-skill 'my-skill' from 'my-package' overwrites existing skill # Passes — tells the user exactly what to do Skipping my-skill — local file exists (not managed by APM). Use 'apm install --force' to overwrite. ``` If the user can't act on it, it's not a warning — it's noise. Demote to `--verbose` or remove. ### 2. The Traffic Light Rule Use color semantics consistently. Never use a warning color for an informational state. | Color | Helper | Meaning | When to use | |-------|--------|---------|-------------| | Green | `_rich_success()` | Success / completed | Operation finished as expected | | Yellow | `_rich_warning()` | User action needed | Something requires user decision | | Red | `_rich_error()` | Error / failure | Operation failed, cannot continue | | Blue | `_rich_info()` | Informational | Status updates, progress, summaries | | Dim | `_rich_echo(color="dim")` | Secondary detail | Verbose-mode details, grouping headers | ### 3. The Newspaper Test Can the user scan output like headlines? Top-level = what happened. Details = drill down. ``` # Bad — warnings break the visual flow betw...

Details

Author
microsoft
Repository
microsoft/apm
Created
10 months ago
Last Updated
2 days ago
Language
Python
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Solid

devx-ux

Activate when designing or modifying CLI command surfaces, command help text, install/init/run flows, error wording, or first-run experience in the APM CLI -- even when the user does not say "UX" explicitly.

3,385 Updated 2 days ago
microsoft
AI & Automation Listed

sota-cli-ux

State-of-the-art CLI and developer-tool UX guidance (2026) covering command and flag design, output and interaction (stdout/stderr, --json, TTY detection, exit codes, prompts), runtime behavior and lifecycle (signals, dry-run, idempotency, XDG paths, completions, telemetry), and distribution (packaging, checksums, docs). Use when designing or building any command line tool, subcommand, TUI, or developer tool — in any framework (argparse, click, typer, clap, cobra, oclif, commander) — AND when auditing an existing CLI for usability, scriptability, and compatibility. Not for shell-script correctness or security — use sota-shell-scripting. Trigger keywords: CLI, command line tool, flags, subcommands, terminal output, TUI, developer tool, argparse, clap, cobra, exit code, shell completion, man page, stdin, stdout.

8 Updated 3 days ago
martinholovsky
Web & Frontend Listed

ui-ux-audit

Comprehensive UI/UX quality audit and prevention system that catches the failures AI consistently ships, including broken or shifting layouts, text overflow, inconsistent components, missing states, poor contrast, undersized touch targets, accessibility violations, performance jank, and generic "AI slop" aesthetics. Use whenever the user asks to audit, review, check, critique, fix, polish, optimize, or improve any UI, page, screen, component, screenshot, or design, or says things like "the layout looks off", "something feels wrong", "this looks AI-generated", "is this ready to ship", "weird spacing", "ugly", or "broken page". ALSO consult this skill silently BEFORE writing or editing any UI code (React, JSX, HTML, CSS, Tailwind, React Native, Expo) so these failures never ship in the first place. Works on any project with no setup, and ships with switchable project-category profiles (example kids-app, SaaS/dashboard, marketing/landing, e-commerce) plus a simulate-the-user-first method; supports adding your ow

1 Updated yesterday
Xza2792