# @blessed/cli

> A CLI to create / scaffold blessed apps

Latest version **1.2.2** (published 2020-12-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install @blessed/cli
pnpm add @blessed/cli
yarn add @blessed/cli
bun add @blessed/cli
```

Provides the command `blessed`.

## 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.2.2 |
| Published | 2020-12-21 |
| First published | 2020-10-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 33.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Rajasegar Chandran |
| Maintainers | rajasegar |
| Keywords | blessed, cli, terminal, scaffold |

## Links

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

## Dependencies (3)

- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [yargs](https://npm.io/package/yargs.md) ^16.0.3
- [prompts](https://npm.io/package/prompts.md) ^2.3.2

## 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.2.2 (latest) — 2020-12-21
- 1.2.1 — 2020-10-15
- 1.2.0 — 2020-10-15
- 1.1.3 — 2020-10-09
- 1.1.1 — 2020-10-09
- 1.1.0 — 2020-10-09
- 1.0.0 — 2020-10-06

## README

# blessed-cli

![Build and Deploy](https://github.com/blessedjs/blessed-cli/Build%20and%20Deploy/badge.svg)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
[![npm version](http://img.shields.io/npm/v/@blessed/cli.svg?style=flat)](https://npmjs.org/package/@blessed/cli "View this project on npm")


A CLI to create / scaffold [blessed](https://github.com/chjj/blessed) apps with conventional folder structure and project setup.

Features:
- Project scaffolding
- Theming setup implemeted by default
- Generate commands for pages and widgets
- Conventional project structure with linting enabled

## Install 

```
npm install -g @blessed/cli
```

## Usage

To open a wizard UI
```
blessed
```

### Create a new blessed CLI project
```
blessed new <project-name>
```

Example:
```
blessed new my-awesome-cli
```

### Create a new page in the CLI
```
cd my-awesome-cli
blessed page <page-name>
```

For example, if you want to create a page named `home`
```
blessed page home
```

You can also use the alias `p` for creating pages
```
blessed p home
```

### Create a new blessed widget inside the project
```
blessed widget <widget-name>
```
By default, this will create a [Box](https://github.com/chjj/blessed#box-from-element) widget.
You can also pass the `--type` option to specify the type of the widget.

```
blessed widget <widget-name> --type list
```

You can also use the alias `w` to create a widget
```
blessed w hello-world --type list
```

List of widgets available
- bigtext
- box
- list
- listbar
- listtable
- loading
- log
- message
- prompt
- question
- table
- text


## Help
```
blessed <command> <params> <options>

Commands:
  blessed new [project-name]    Create a new blessed project
  blessed page [page-name]      Create a new page component         [aliases: p]
  blessed widget [widget-name]  Create a new blessed widget         [aliases: w]

Options:
      --version  Show version number                                   [boolean]
      --help     Show help                                             [boolean]
  -d, --dry-run  Dry Run: Verify the command without executing         [boolean]

For more information, see https://github.com/terminal-junkies/blessed-cli

```

### Projects created with blessed-cli
- ember-cli-next
- ember-app-explorer
- ember-observer-cli
- nvm-tui
- npmx

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