https://github.com/derhuerst/cli-styles

A consistent look & feel for CLI prompts.
https://github.com/derhuerst/cli-styles

cli prompt

Last synced: 5 days ago
JSON representation

A consistent look & feel for CLI prompts.

• Host: GitHub
• URL: https://github.com/derhuerst/cli-styles
• Owner: derhuerst
• License: isc
• Created: 2016-03-20T15:18:25.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2018-03-31T15:11:10.000Z (over 6 years ago)
• Last Synced: 2024-10-03T23:56:01.237Z (about 1 month ago)
• Topics: cli, prompt
• Language: JavaScript
• Homepage: https://github.com/derhuerst/cli-styles
• Size: 18.6 KB
• Stars: 6
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license.md

Awesome Lists containing this project

README

        
# cli-styles 🕶

This project aims to bring a **consistent look to CLI apps**. It provides:

- styles of showing user input (`default`, `password`, `invisible`)

- indicators for the status of a prompt (`?`, `✔`, `✖`)

- a prompt delimiter (`›`)

***Note*: This project *is not* a prompt or a command line executable, it intends to standardize interfaces of CLI tools.**

`cli-styles` works well with [`prompt-skeleton`](https://github.com/derhuerst/prompt-skeleton).

[![npm version](https://img.shields.io/npm/v/cli-styles.svg)](https://www.npmjs.com/package/cli-styles)

[![build status](https://img.shields.io/travis/derhuerst/cli-styles.svg)](https://travis-ci.org/derhuerst/cli-styles)

[![dependency status](https://img.shields.io/david/derhuerst/cli-styles.svg)](https://david-dm.org/derhuerst/cli-styles#info=dependencies)

![ISC-licensed](https://img.shields.io/github/license/derhuerst/cli-styles.svg)

[![chat on gitter](https://badges.gitter.im/derhuerst.svg)](https://gitter.im/derhuerst)

[![support me on Patreon](https://img.shields.io/badge/support%20me-on%20patreon-fa7664.svg)](https://patreon.com/derhuerst)

## Prompts using *cli-styles*

- [`date-prompt`](https://github.com/derhuerst/date-prompt)

- [`mail-prompt`](https://github.com/derhuerst/mail-prompt)

- [`multiselect-prompt`](https://github.com/derhuerst/multiselect-prompt)

- [`number-prompt`](https://github.com/derhuerst/number-prompt)

- [`range-prompt`](https://github.com/derhuerst/range-prompt)

- [`select-prompt`](https://github.com/derhuerst/select-prompt)

- [`text-prompt`](https://github.com/derhuerst/text-prompt)

- [`tree-select-prompt`](https://github.com/derhuerst/tree-select-prompt)

- [`cli-autocomplete`](https://github.com/derhuerst/cli-autocomplete)

- [`switch-prompt`](https://github.com/derhuerst/switch-prompt)

## Installing

```

npm install cli-styles

```

## Usage

See [the source](index.js)

## Contributing

If you **have a question**, **found a bug** or want to **propose a feature**, have a look at [the issues page](https://github.com/derhuerst/cli-styles/issues).