cliux

A home for CLI UX work: interactive prototypes, reusable design-review UI elements, and CLI UX guidelines.

The site is published with GitHub Pages so anything under this repo can be deployed and shared with engineers as a link.

🔗 Live site: https://hyoshis.github.io/cliux/

What lives here

Folder	Purpose
prototypes/	Self-contained, deployable prototypes. Each gets its own shareable URL.
components/	Reusable design-review UI elements (e.g. clickable Next buttons, design-decision callouts) used to build and annotate prototypes.
guidelines/	Written CLI UX guidelines, principles, and patterns.
assets/	Shared CSS, JS, and images used across prototypes and components.

Sharing a prototype

Each prototype is a static folder. Once pushed to main, it is live at:

https://hyoshis.github.io/cliux/prototypes/<prototype-name>/

Send that link to engineers — no build step, no local setup required.

Adding a new prototype

1. Copy an existing folder in prototypes/ (or start from scratch).
2. Keep it self-contained: an index.html plus any local assets, or reference shared files from /assets.
3. Add a short entry to prototypes/README.md and a link on the landing index.html.
4. Commit and push to main. It goes live automatically.

Enabling GitHub Pages (one-time)

Repo Settings → Pages → Build and deployment:

• Source: Deploy from a branch
• Branch: main / / (root)

The landing page (index.html) then serves at the live site URL above and links to every prototype.

Local preview

No build required — it's static. To preview locally:

# from the repo root
python -m http.server 8000
# then open http://localhost:8000

Conventions

• Static only. Everything must run as plain static files so GitHub Pages can host it.
• Self-contained prototypes. A prototype should work when opened on its own.
• Shared > duplicated. Put anything reused across prototypes in components/ or assets/.