ux-linter
Checklist and best practices for validating CLI tool user experience. Use this skill for 'CLI UX validation', 'usability check', 'output format verification', 'error message review', 'interaction pattern inspection', and other CLI UX quality checks. Note: GUI usability testing and accessibility certification are outside the scope of this skill.
Best use case
ux-linter is best used when you need a repeatable AI agent workflow instead of a one-off prompt.
Checklist and best practices for validating CLI tool user experience. Use this skill for 'CLI UX validation', 'usability check', 'output format verification', 'error message review', 'interaction pattern inspection', and other CLI UX quality checks. Note: GUI usability testing and accessibility certification are outside the scope of this skill.
Teams using ux-linter should expect a more consistent output, faster repeated execution, less prompt rewriting.
When to use this skill
- You want a reusable workflow that can be run more than once with consistent structure.
When not to use this skill
- You only need a quick one-off answer and do not need a reusable workflow.
- You cannot install or maintain the underlying files, dependencies, or repository context.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/ux-linter/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How ux-linter Compares
| Feature / Agent | ux-linter | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
Checklist and best practices for validating CLI tool user experience. Use this skill for 'CLI UX validation', 'usability check', 'output format verification', 'error message review', 'interaction pattern inspection', and other CLI UX quality checks. Note: GUI usability testing and accessibility certification are outside the scope of this skill.
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
Related Guides
SKILL.md Source
# UX Linter — CLI User Experience Validation Checklist
A skill that enhances UX quality verification for the test-engineer and docs-writer.
## Target Agents
- **test-engineer** — Systematically performs CLI usability testing
- **docs-writer** — Writes documentation from the user's perspective
## CLI UX 12-Principle Checklist
### 1. Discoverability
```
[ ] Does --help provide useful information?
[ ] Is the subcommand list displayed with descriptions?
[ ] Is there a "Did you mean...?" suggestion for wrong commands?
[ ] Is there an Examples section?
```
### 2. Feedback
```
[ ] Is there progress indication during operations? (bar/spinner)
[ ] Is success/failure clearly distinguished?
[ ] Is estimated time shown for long operations?
[ ] Is a result summary provided?
```
### 3. Error Handling
```
[ ] Are error messages specific? (what went wrong and how to fix it)
[ ] Are errors and warnings distinguished?
[ ] Are errors output to stderr? (prevents stdout contamination)
[ ] Are exit codes appropriate? (0: success, non-0: failure)
```
### 4. Pipe-Friendly
```
[ ] Does stdout output structured data?
[ ] Can output be switched between human/machine format? (--json, --quiet)
[ ] Can input be read from stdin? (pipe)
[ ] Are colors auto-disabled when piped? (isatty check)
```
### 5. Configuration
```
[ ] Is the config file path displayed?
[ ] Is the priority of env vars + config file + CLI options clear?
[ ] Are defaults reasonable?
[ ] Is there a command to check current settings?
```
## Error Message Format Standard
### BAD (patterns to avoid)
```
Error: invalid input
Error: operation failed
Exception: NullPointerException at line 42
```
### GOOD (recommended patterns)
```
Error: Input file not found: data.json
Check the path or specify with the --input option.
Example: mytool convert --input /path/to/data.json
Error: JSON parsing failed (line 15, column 8)
There is an unclosed brace.
Hint: Check syntax with jsonlint data.json
```
### Error Message Components
```
1. [What happened] — Problem description
2. [Why it happened] — Cause (when possible)
3. [How to fix it] — Resolution
4. [More info] — Documentation link, related commands
```
## Output Format Guide
### Table Output
```
NAME STATUS SIZE MODIFIED
config.yml active 2.4 KB 2025-01-15
data.json pending 156 KB 2025-01-14
```
### JSON Output (--json)
```json
[
{"name": "config.yml", "status": "active", "size": 2400},
{"name": "data.json", "status": "pending", "size": 156000}
]
```
### Progress Indicators
```
TTY (terminal):
Processing... [████████░░░░░░░░] 50% (15/30 files)
Non-TTY (pipe/redirect):
Processing 15/30 files...
Processing 30/30 files... done.
```
## Color Usage Guide
| Meaning | Color | ANSI |
|---------|-------|------|
| Success | Green | `\033[32m` |
| Warning | Yellow | `\033[33m` |
| Error | Red | `\033[31m` |
| Info | Blue | `\033[34m` |
| Emphasis | Bold | `\033[1m` |
| Secondary | Gray | `\033[90m` |
```
Rules:
1. Disable colors when NO_COLOR environment variable is present
2. Auto-disable when piped/redirected
3. Provide --no-color option
4. Content must be meaningful without colors
```
## Interactive Patterns
```
Confirmation prompt (dangerous operations):
Are you sure you want to delete? [y/N]: _
-> Uppercase is the default (N = default No)
-> Skip with --force / --yes
Selection prompt:
Select output format:
> json
yaml
toml
-> Arrow key selection (TTY only)
Dry run:
--dry-run option for preview without actual changes
```
## UX Validation Report Template
```markdown
## CLI UX Validation Report
### 12-Principle Status
| Principle | Status | Notes |
|-----------|--------|-------|
### Error Message Quality
| Scenario | Current Message | Suggested Improvement |
### Output Format Verification
| Command | Terminal Output | Pipe Output | JSON |
```Related Skills
sustainability-audit
Full audit pipeline for ESG/sustainability where an agent team collaborates to generate environmental, social, and governance assessments along with an integrated report and improvement plan. Use this skill for requests such as 'run an ESG audit', 'write a sustainability report', 'ESG assessment', 'carbon emissions calculation', 'ESG rating diagnosis', 'governance review', 'social responsibility assessment', 'GRI report', 'TCFD disclosure', 'ESG improvement plan', and other ESG/sustainability tasks. Also supports assessment of specific pillars (E/S/G) only or improving existing reports. However, actual on-site audit execution, third-party verification certificate issuance, ESG rating agency score changes, and carbon credit trading are outside the scope of this skill.
materiality-assessment
ESG materiality assessment matrix. Referenced by the esg-reporter and improvement-planner agents when evaluating ESG issue materiality and setting priorities. Use for 'materiality assessment', 'importance analysis', or 'Materiality Matrix' requests. Stakeholder surveys and external certification are out of scope.
ghg-protocol
GHG Protocol detailed guide. Referenced by the environmental-analyst agent when calculating and reporting greenhouse gas emissions. Use for 'GHG Protocol', 'carbon emissions', 'Scope 1/2/3', or 'carbon footprint' requests. Carbon credit trading and CDM project execution are out of scope.
citation-standards
Academic citation and reference standards guide. Referenced by the paper-writer and submission-preparer agents when composing citations and references. Use for 'citation format', 'APA', or 'references' requests. Original paper retrieval and professional database access are out of scope.
academic-paper
Full research pipeline for academic paper writing where an agent team collaborates to generate research design, experiment protocols, analysis, manuscript writing, and submission preparation. Use this skill for requests such as 'write an academic paper', 'research paper writing', 'help me write a paper', 'design a study', 'run statistical analysis', 'prepare journal submission', 'manuscript writing', 'research methodology design', 'hypothesis testing', 'academic writing', and other academic research paper tasks. Also supports analysis, rewriting, and submission preparation when existing data or drafts are available. However, actual data collection execution, official IRB submission, journal system login and upload, and running actual statistical software are outside the scope of this skill.
product-copy-formulas
Product copy formula library. Referenced by the detail-page-writer and marketing-manager agents when writing purchase-driving copy. Use for 'product copy', 'marketing copy', or 'ad copy' requests. Ad placement and design mockup creation are out of scope.
ecommerce-launcher
Full launch pipeline for e-commerce products where an agent team collaborates to generate product planning, detail pages, pricing strategy, marketing, and CS setup all at once. Use this skill for requests such as 'launch an e-commerce product', 'prepare a product launch', 'register a product on Naver Smart Store', 'launch on Coupang', 'create a detail page', 'develop a pricing strategy', 'create a marketing plan', 'launch prep', 'product planning brief', 'e-commerce CS manual', and other e-commerce product launch tasks. Also supports supplementing pricing/marketing/CS even when existing briefs or detail pages are provided. However, actual platform API integration (automated product registration), payment system development, logistics system integration, and real-time order management are outside the scope of this skill.
conversion-optimization
Purchase conversion optimization framework. Referenced by the detail-page-writer and pricing-strategist agents when designing detail pages and pricing with a conversion focus. Use for 'conversion rate optimization', 'CRO', or 'purchase psychology' requests. A/B testing tool setup and funnel automation are out of scope.
real-estate-analyst
Real estate investment analysis pipeline. An agent team collaborates to produce market research, location analysis, profitability analysis, risk assessment, and investment reports. Use this skill for requests such as 'analyze this real estate', 'apartment investment analysis', 'studio apartment yield', 'real estate market research', 'location analysis', 'real estate investment report', 'buy vs lease', 'reconstruction investment analysis', 'commercial property yield analysis', and other general real estate investment analysis tasks. Actual purchase contracts, brokerage services, interior design, and property management are outside the scope of this skill.
location-scoring
Location scoring scorecard. Referenced by the location-analyst agent for systematic real estate location evaluation. Use for requests involving 'location analysis', 'location assessment', or 'commercial area analysis'. On-site inspections and surveying are out of scope.
cap-rate-calculator
Real estate yield calculator. Reference formulas and models used by the profitability-analyst agent for quantitative investment return analysis. Use for requests involving 'Cap Rate', 'yield analysis', 'DCF', or 'cash flow analysis'. Tax advisory and loan underwriting are out of scope.
vendor-scoring
Vendor evaluation scorecard framework. Referenced by vendor-comparator and evaluation-designer agents when systematically comparing and evaluating vendors. Used for 'vendor evaluation', 'supplier comparison', 'bid evaluation' requests. Note: posting bid announcements and executing contracts are out of scope.