# cli-step

> Module to create yarn like steps for your cli app

Latest version **1.0.2** (published 2017-10-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install cli-step
pnpm add cli-step
yarn add cli-step
bun add cli-step
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2017-10-11 |
| First published | 2017-10-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 41 |
| Author | virk |
| Maintainers | virk |
| Keywords | cli, yarn, cli-steps |

## Links

- npm: https://www.npmjs.com/package/cli-step
- Repository: https://github.com/poppinss/cli-step
- Homepage: https://github.com/poppinss/cli-step#readme
- Issues: https://github.com/poppinss/cli-step/issues
- npm.io page: https://npm.io/package/cli-step

## Dependencies (3)

- [colors](https://npm.io/package/colors.md) ^1.1.2
- [node-emoji](https://npm.io/package/node-emoji.md) ^1.8.1
- [cli-spinner](https://npm.io/package/cli-spinner.md) ^0.2.6

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2017-10-11
- 1.0.1 — 2017-10-11
- 1.0.0 — 2017-10-11

## README

# Cli steps ⛹

This module makes it super simple to show animated steps on the terminal and also track the time spent to perform those steps.

> Highly inspired by [yarn](https://yarnpkg.com/en)

## Some bragging 🤘🏻

Below is the output of couple of [examples](examples) of what you can do with `cli-step`.

#### Yarn style [output](https://github.com/poppinss/cli-step/blob/master/examples/yarn.js)

![](http://res.cloudinary.com/adonisjs/image/upload/q_100/v1507656383/yarn_tn8ztw.gif)


#### Publish to [npm](https://github.com/poppinss/cli-step/blob/master/examples/publish.js)

![](http://res.cloudinary.com/adonisjs/image/upload/q_100/v1507656397/publish_jr4ivb.gif)

## Usage ✍️

Grab it from npm.

```bash
npm i cli-step

# yarn
yarn add cli-step
```

```js
const Steps = require('cli-step')

const totalNumberOfSteps = 4
const steps = new Steps(totalNumberOfSteps)

const step1 = steps
    .advance('Resolving packages', 'mag')
    .start()

// perform your task
step1.stop()

const step2 = steps
    .advance('Fetching packages', 'truck')
    .start()

// peform next task
step2.stop()
```

## Note 🗒️

Cli steps doesn't gives you any functionality on how to perform certain actions, it's just a module to show animated steps of the tasks you are executing. 

So think of it as the UI layer for your command line app.

## Why? 🤷‍♂️

1. To produce consistent output
2. Everyone loves emoji's
3. Record time taken to perform all the steps.

## API 👇🏻
Here's the list of methods you can call to tweak the output.


#### advance(text, emoji, helpLabel)

- **text ( String ) [required]**
The text to be printed on the terminal. It is required
- **emoji (String) [optional]**
Emoji to be printed just before the text. The emoji name must one of the available emojis from this [list](https://raw.githubusercontent.com/omnidan/node-emoji/master/lib/emoji.json)
- **helpLabel (String) [optional]**
The help label to be printed in DIM color. For example showing the command used to execute the task

```js
const steps = new Steps(4)
const stepInstance = steps.advance(text, emoji, helpLabel)
```

#### startRecording

Optionally, you can start recording the time which can later be used to know the time taken to execute all the tasks. **Used in yarn example**

```js
const steps = new Steps(4)
steps.startRecording()

// perform all tasks

const nanoSeconds = steps.stopRecording()
```

#### stopRecording
Used to stop recording the time. The return value is the time spent between `startRecording` and `stopRecording` in **nano seconds**.


## A single step ☝️

Everytime you call `advance` it returns an instance of the [step](https://github.com/poppinss/cli-step/blob/master/index.js#L54) class, which can be used to tweak the output, complete a step and so on.

```js
const step1 = steps.advance('Linting...', null, 'npm run lint')

step1.start() // start the animation

try {
 // perform task
 
 step1.success('Successfully linted', 'white_check_mark')
} catch (error) {
  step1.error('Unable to lint', 'x')
}
```

#### start
The start method starts the animation for a given step.

```js
step.start()
```

#### success(text, emoji)
- **text ( String ) [optional]**
Optionally change the text on step completion
- **emoji (String) [optional]**
Optionally change the emoji on step completion

```js
step1.complete()

// or change text
step1.complete('Success')

// or change text and emoji
step1.complete('Success', 'white_check_mark')
```

#### error(text, emoji)
- **text ( String ) [optional]**
Optionally change the text on error
- **emoji (String) [optional]**
Optionally change the emoji on error

```js
step1.error()

// or change text
step1.error('Ohh no!')

// or change text and emoji
step1.error('Ohh no!', 'x')
```

#### stop()
Same as `error` and `complete` but instead doesn't accept any params and just stops the animation.

#### update(text)
- **text ( String ) [required]**
Update the step text during animation.

```js
step1.start()

// after a while
step1.update('Changing the text')
```

## Spinner 🤸‍♂️

The [cli-spinner](https://npmjs.org/package/cli-spinner) module is used to show the loading icon. You can tweak the behaviour by accessing the `spinner` property on the `step` instance.

```js
const Steps = require('cli-step')
const steps = new Steps(1)

const step = steps.advance('Eating banana', 'banana')

// update the spinner string
step.spinner.setSpinnerString(10)

// start animation
step.start()
```

![](http://res.cloudinary.com/adonisjs/image/upload/q_100/v1507702118/banana_gyyzbk.gif)

## Props 🎉

The module is possible because of

- [cli-spinner](https://www.npmjs.com/package/cli-spinner)
- [node-emoji](https://www.npmjs.com/package/node-emoji)
- [colors](https://www.npmjs.com/package/colors)
- [yarn](https://yarnpkg.com/en)

---
_Source: https://npm.io/package/cli-step · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._