flagstaff
API reference

flagstaff

Every export of flagstaff, with its signature and doc comment: hoist, manualClock, frameWriter, box, boxComponent, fromCliSpinners and 14 more, plus 32 types.

flagstaff — the staff the flag flies from. Re-exports only; each subpath is its own entry and costs only itself, so prefer flagstaff/spinner when that is all you need.

import { hoist, manualClock, frameWriter, … } from 'flagstaff';

Functions

progress

A progress bar: 12/30 files · 40% off a terminal, a drawn bar on one. This is the root entry's, which always draws; flagstaff/progress reports to an MCP client instead, inside a call that asked.

function progress({ width, glyphs }?: ProgressOptions): Component<ProgressState>;
ParameterType
{ width, glyphs } (optional)ProgressOptions

Returns Component<ProgressState>

Re-exported

Documented on the page of the entry point that declares them.

ExportKindDocumented in
boxfunctionflagstaff/box
boxComponentfunctionflagstaff/box
frameWriterfunctionflagstaff/loop
fromCliBoxesfunctionflagstaff/import
fromCliSpinnersfunctionflagstaff/import
glyphfunctionflagstaff/plugin
hoistfunctionflagstaff/loop
lookupBorderfunctionflagstaff/plugin
lookupSpinnerfunctionflagstaff/plugin
manualClockfunctionflagstaff/loop
registerfunctionflagstaff/plugin
registeredfunctionflagstaff/plugin
spinnerfunctionflagstaff/spinner
tablefunctionflagstaff/table
tableComponentfunctionflagstaff/table
tasksfunctionflagstaff/tasks
validatefunctionflagstaff/plugin
PluginErrorclassflagstaff/plugin
CONTRACTconstflagstaff/plugin
BorderStyleinterfaceflagstaff/plugin
BoxOptionsinterfaceflagstaff/box
BoxStateinterfaceflagstaff/box
CliSpinnerinterfaceflagstaff/import
Clockinterfaceflagstaff/loop
ColumnOptionsinterfaceflagstaff/table
Componentinterfaceflagstaff/plugin
FrameWriterinterfaceflagstaff/loop
FromCliBoxesOptionsinterfaceflagstaff/import
FromCliSpinnersOptionsinterfaceflagstaff/import
Hoistedinterfaceflagstaff/loop
Linkedinterfaceflagstaff/table
ManualClockinterfaceflagstaff/loop
Plugininterfaceflagstaff/plugin
ProgressOptionsinterfaceflagstaff/progress
ProgressStateinterfaceflagstaff/progress
Runtimeinterfaceflagstaff/loop
SpinnerDefinterfaceflagstaff/plugin
SpinnerStateinterfaceflagstaff/spinner
TableOptionsinterfaceflagstaff/table
TableStateinterfaceflagstaff/table
Taskinterfaceflagstaff/tasks
TasksOptionsinterfaceflagstaff/tasks
TasksStateinterfaceflagstaff/tasks
Writerinterfaceflagstaff/loop
Celltypeflagstaff/table
CliBoxtypeflagstaff/import
PluginErrorCodetypeflagstaff/plugin
Rowtypeflagstaff/table
SpinnerStatustypeflagstaff/spinner
TaskStatustypeflagstaff/tasks
Terminaltypeflagstaff/box

On this page