skills.rest
microsoft
microsoftOFFICIAL
Explore all skills by this author →
Website𝕏@OpenAtMicrosoftGitHub

cli-logging-ux

Apply standardized CLI logging and UX patterns using the CommandLogger API.

3.5k|319|Updated Sep 18, 2025
Search Tags:#logging#cli#diagnostics#ux#console-output#command-logger
One-click install
npx skills add https://github.com/microsoft/apm --skill cli-logging-ux
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: cli-logging-ux
Source: https://github.com/microsoft/apm/tree/main/.apm/skills/cli-logging-ux
Command: npx skills add https://github.com/microsoft/apm --skill cli-logging-ux

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Editing or creating CLI output, logging, warnings, error messages, progress indicators, or diagnostic summaries in the APM codebase is error-prone and inconsistent. This skill provides a unified approach to CLI UX, ensuring messages are clear, actionable, and readable across commands.

Core Features & Use Cases

  • Standardized formatting for warnings, errors, progress indicators, and diagnostics using a shared set of console helpers.
  • Guidance on when to show inline output vs deferred diagnostics to keep user attention focused.
  • Architecture and rules for using the CommandLogger to gate verbose output, enforce consistent prefixes, and render diagnostics at the end of operations.

Quick Start

Integrate the provided CommandLogger patterns into CLI commands to standardize output and improve UX.

Frequently Asked Questions about cli-logging-ux

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I standardize CLI logging and console output across multiple commands?▼

To standardize CLI logging, you apply a shared CommandLogger API that enforces consistent prefixes, verbose gating rules, and clean output structure for warnings, progress, and errors across all commands.

What is the best way to format CLI warnings, errors, and diagnostic summaries?▼

The best way to format CLI diagnostics is using standardized console helpers that render deferred diagnostic summaries at the end of operations, keeping user attention focused on inline output.

How do I gate verbose output in a command-line interface without cluttering the console?▼

You gate verbose CLI output by implementing the CommandLogger architecture, which applies verbose gating rules to control when detailed diagnostic messages appear during command and packaging operations.

When should I show inline CLI output versus deferred diagnostics?▼

Show inline CLI output for immediate actionable messaging and defer diagnostics to the end of the operation to maintain a clean console structure and keep user attention focused.

Why are my CLI error messages and progress indicators inconsistent across different commands?▼

Inconsistent CLI error messages and progress indicators occur when commands lack a unified logging approach; applying a standardized CommandLogger API enforces consistent formatting and prefixes across the codebase.

Do I need specific dependencies to enforce consistent command-line UX patterns?▼

No specific dependencies are required to enforce consistent command-line UX patterns; the skill provides a self-contained CommandLogger API and console helper rules to integrate directly into your codebase.

Related Skills

Explore More Software Engineering Skills→
vm0-aivm0-ai
1.1k

CLI Design

Define consistent symbols, colors, and messaging for VM0 CLI commands.

Official
Basic
lilienblumlilienblum
62

cli-output

Standardize Tako CLI output across normal, verbose, and CI modes.

Community
Advanced
QunnnnQunnnn

dart-build-cli-app

Build Dart command-line applications with argument parsing and testing workflows.

Community
Advanced
ColdBoxColdBox

logbox

Configure LogBox appenders, categories, and async logging for ColdBox applications.

Official
Advanced