Terminal user interface for managing Quartz.
  • TypeScript 99.7%
  • JavaScript 0.3%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Emile Bangma 485847b3a1
Merge pull request #4 from quartz-community/dev-mode/windows-npx
fix: run npx through cmd.exe on Windows; first tests
2026-11-09 18:19:35 +01:00
.github/workflows ci: publish job can use npm trusted publishing (id-token, Node 24); keeps NPM_TOKEN for the first release 2026-11-08 14:01:29 +01:00
src fix: run npx through cmd.exe on Windows (npx.cmd, quoted and whitelisted), so plugin install/update/add/remove work there; first tests 2026-11-09 18:11:06 +01:00
test fix: run npx through cmd.exe on Windows (npx.cmd, quoted and whitelisted), so plugin install/update/add/remove work there; first tests 2026-11-09 18:11:06 +01:00
types chore: add centralized type declarations and .prettierignore 2026-03-16 18:55:00 +01:00
.gitignore Initial commit 2026-02-25 12:32:11 +01:00
.prettierignore chore: add centralized type declarations and .prettierignore 2026-03-16 18:55:00 +01:00
build.mjs feat: configure TUI plugin infrastructure (package.json, tsconfig, esbuild) 2026-02-25 19:09:43 +01:00
CHANGELOG.md Initial commit 2026-02-25 12:32:11 +01:00
LICENSE Initial commit 2026-02-25 12:32:11 +01:00
package-lock.json chore(deps): security updates in range (shell-quote, ws, yaml); esbuild 0.28 as a devDependency (build only) 2026-11-08 01:18:43 +01:00
package.json fix: run npx through cmd.exe on Windows (npx.cmd, quoted and whitelisted), so plugin install/update/add/remove work there; first tests 2026-11-09 18:11:06 +01:00
README.md feat: configure TUI plugin infrastructure (package.json, tsconfig, esbuild) 2026-02-25 19:09:43 +01:00
tsconfig.json chore: add centralized type declarations and .prettierignore 2026-03-16 18:55:00 +01:00

@quartz-community/tui

An interactive terminal UI for managing Quartz plugins, configuration, and layout. Built with OpenTUI and requires the Bun runtime.

Installation

npx quartz plugin add github:quartz-community/tui

Usage

Launch the TUI from your Quartz project root:

npx quartz tui

Or equivalently:

npx quartz plugin

The TUI provides three panels:

Plugins Panel

  • Browse installed plugins with status indicators (enabled/disabled)
  • Add plugins from Git repositories
  • Remove installed plugins
  • Update plugins to latest versions
  • Enable/disable plugins in your configuration

Settings Panel

  • Edit quartz.config.yaml settings interactively
  • Modify site title, description, base URL, and other options
  • Reset settings to defaults

Layout Panel

  • View and reorder layout components (head, header, beforeBody, left, right, afterBody, footer)
  • Drag-and-drop style reordering of plugin positions within each layout zone

Requirements

  • Bun runtime: The TUI requires Bun to run (OpenTUI uses bun:ffi for its Zig-based terminal renderer)
  • Quartz v5: Must be run from within a Quartz v5 project directory

Architecture

The TUI operates as a standalone plugin that interacts with your Quartz project through two mechanisms:

  • CLI bridge: Git-based plugin operations (add, remove, update, install, restore) shell out to npx quartz plugin <subcommand>
  • Direct YAML I/O: Configuration reads/writes operate directly on quartz.config.yaml and quartz.lock.json

Documentation

See the Quartz documentation for more information.

License

MIT