CLI reference

The public ESM package supports pnpm, npm, yarn, and bun; TypeScript and JavaScript output; scoped registries; JSON output; dry runs; and explicit conflict handling.

bash

pnpm dlx aq-ui@alpha --helppnpm dlx aq-ui@alpha --help

Command	Purpose
aq-ui init	Detect the project and create the aq-ui configuration and theme.
aq-ui add	Resolve the dependency graph, select editor languages, and install source atomically.
aq-ui list / search / info	Explore registry metadata without mutating the project.
aq-ui diff	Compare installed hashes, local source, and current upstream records.
aq-ui update	Update clean files while protecting local modifications.
aq-ui remove	Remove owned files only when changes are safe or forced.
aq-ui doctor	Validate aliases, manifests, files, dependencies, and registry access.
aq-ui theme	Install or update the aq-neutral OKLCH token block.
aq-ui migrate	Normalize an existing shadcn-compatible configuration for aq-ui.

Granular editor languages

CodeMirror language loaders are separate registry items. The default production preset installs plaintext, JavaScript, TypeScript, JSX, TSX, JSON, HTML, CSS, and Markdown; YAML and SQL are opt-in. A Markdown editor always keeps its required Markdown loader.

bash

pnpm dlx aq-ui@alpha add code-editor --languages typescript,json,yaml
pnpm dlx aq-ui@alpha add markdown-editor --languages typescript,sql
pnpm dlx aq-ui@alpha add code-editor --languages allpnpm dlx aq-ui@alpha add code-editor --languages typescript,json,yamlpnpm dlx aq-ui@alpha add markdown-editor --languages typescript,sqlpnpm dlx aq-ui@alpha add code-editor --languages all

Safety model

HTTPS is required except for explicit localhost and local-file development registries.
Paths are normalized and checked for traversal, absolute targets, and symlink escapes.
Writes are transactional and roll back if a later operation fails.
Lifecycle scripts are disabled during dependency installation.
Local modifications require an explicit --force before overwrite or removal.