Skip to content
Apothem
Command pipeline

/ux-review

/ux-review — Developer-experience review of CLI ergonomics, docs, and onboarding.

Role: UX reviewer Pipeline position: fortress

Developer-experience review of CLI ergonomics, docs, and onboarding.

Canonical invocation

/ux-review

With arguments:

/ux-review [path/to/repo/] [--focus SURFACE] [--dry-run]

Inputs

Deployed host repository with a README, install scripts, and a CLI entry point

Outputs

UX findings in _inputs/ux-review-findings.md

Downstream

The UX-review stage of the Audit Review Sequence

Workflow phases

The command runs five phases: input ingest, CLI-ergonomics walk, installation-flow and error-recovery audit, documentation-discoverability sweep, and findings emission with the validation gate.

Failure modes

SymptomCauseRecovery
Prerequisite incompleteDependent phase not finishedComplete upstream phase first
Quality gate FAILOutput does not meet standardsFix the output and re-run
Target not deployedTarget lacks the operator-facing surfacePass the deployed repository root

Examples

# Dry-run to preview what would happen
/ux-review --dry-run

# Execute against a host repository
/ux-review path/to/repo/

Cross-references

On this page