Skip to content

README.md

Latest commit

 

History

History
75 lines (62 loc) · 2.71 KB

README.md

File metadata and controls

75 lines (62 loc) · 2.71 KB

@flux-lang/cli-ui

@flux-lang/cli-ui version @flux-lang/cli-ui stable channel @flux-lang/cli-ui canary channel License Maintained status

  1. What this package is Ink-based terminal UI for the Flux CLI.

  2. When you use it Use it when you want an interactive TTY UI on top of the CLI command set.

  3. Install

pnpm add @flux-lang/cli-ui
  1. Basic usage
import { runCliUi } from "@flux-lang/cli-ui";
import { coerceVersionInfo } from "@flux-lang/brand";

await runCliUi({ cwd: process.cwd(), versionInfo: coerceVersionInfo({ version: "0.1.13" }) });
  1. Reference
  • Public entry point: @flux-lang/cli-ui → src/index.tsx
  • UI launcher: runCliUi (calls Ink render() with the app shell)
  • State exports: dashboard-machine

  1. How it relates to IR/runtime The UI delegates all parsing/rendering/runtime work to @flux-lang/cli-core and surfaces status for docstep/time/seed.

  2. Gotchas & troubleshooting

  • The UI is intended for TTY environments; for non-interactive usage, use the plain CLI with --no-ui.

  1. Versioning / compatibility notes TBD / Not yet implemented.

  2. Links