@qui-cli/progress

@qui-cli Plugin: Progress bar for CLI app


Install

``sh
npm install @qui-cli/progress
`

Usage

`ts
import { Progress } from '@qui-cli/progress';

Progress.start({ max: 10 });
for (let i = 0; i < 10; i++) {
// do a thing
Progress.increment();
Progess.caption(Step ${i});
}
Progress.stop();
`

Configuration

Progress provides no configuration options.

Options

Progress adds no user-configurable command line options.

Initialization

Progress requires no initialization

API

`ts
import { Progress } from '@qui-cli/progress';
`

$3

Start a progress bar with max steps at value position (if undefined, value` is 0).

$3

Increment the progress bar one step.

$3

Update the caption on the progress bar.

$3

Stop the progress bar.

CAUTION The progress bar must be stopped for the process to end. If it is not ended, it will run indefinitely.