What problem does it solve?
Reduce friction when exploring a repository or communicating designs by providing a single command to view files, browse directories, or generate readable visual explanations, slides, diagrams, diffs, and recaps from project content.
Core Features & Use Cases
- View Mode: browse or render markdown and directory trees in a novel-reader UI and start/stop a local preview server for interactive inspection.
- Generation Modes: produce visual explanations, presentation slides, architecture diagrams, ASCII diagrams, and HTML-only outputs such as diffs, plan reviews, and project recaps.
- HTML Output: create self-contained HTML files using curated templates with mandatory theme toggle, zoom controls for Mermaid diagrams, and palette/typography rules from design references.
- Templates & References: leverages bundled templates and reference guidance to enforce styling, mermaid v11 usage, output locations, and plan-aware save paths.
- Error handling & UX: argument resolution, path/context fallback, overwrite semantics, and explicit user prompts for ambiguous inputs.
Quick Start
Use the ck:preview skill to generate a self-contained HTML explanation for "Project Architecture" by invoking /ck:preview --html --explain Project Architecture