# @yor/cli

> ```bash npm install -g @yor/cli or yarn global add @yor/cli ```

Latest version **1.0.6** (published 2022-05-25) · MIT license · 0 weekly downloads

## Install

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

Provides the command `yor`.

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2022-05-25 |
| First published | 2022-05-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 17.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Spimy |
| Maintainers | spimy |
| Keywords | nodejs, yor, discord.js, discord-js-bot, discord, bot, command, handler, boilerplate, cli, command-line-interface, utility |

## Links

- npm: https://www.npmjs.com/package/@yor/cli
- Repository: https://github.com/Spimy/yor
- Homepage: https://github.com/Spimy/yor/tree/main/packages/cli#readme
- Issues: https://github.com/Spimy/yor/issues
- npm.io page: https://npm.io/package/@yor/cli

## Dependencies (7)

- [path](https://npm.io/package/path.md) ^0.12.7
- [chalk](https://npm.io/package/chalk.md) 4.1.2
- [clear](https://npm.io/package/clear.md) ^0.1.0
- [yargs](https://npm.io/package/yargs.md) ^17.4.1
- [figlet](https://npm.io/package/figlet.md) ^1.5.2
- [fs-extra](https://npm.io/package/fs-extra.md) ^10.1.0
- [inquirer](https://npm.io/package/inquirer.md) ^8.2.4

## 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.6 (latest) — 2022-05-25
- 1.0.5 — 2022-05-25
- 1.0.4 — 2022-05-06
- 1.0.3 — 2022-05-06
- 1.0.2 — 2022-05-02
- 1.0.1 — 2022-05-02
- 1.0.0 — 2022-05-02

## README

# Yor CLI

## Installation

```bash
npm install -g @yor/cli
or
yarn global add @yor/cli
```

## Commands

The CLI works in 2 different ways. One is to just type out all the information and the second is interactive.

### First way

1. Create new project:

```bash
yor --new <project-name>
or
yor -n <project-name>
```

2. Generate new command:

```bash
yor --command <command-name>
or
yor -c <command-name>
```

3. Generate new event:

```bash
yor --event <event-name>
or
yor -e <event-name>
```

There is no validation for the event name. It can be named anything so when you go into the file itself, you may need to change the event yourself.

### Second way

This is the interactive way. If you do not provide any options, you will be immediately greeted interactively. Simply running `yor` is enough.

![Interactive CLI Preview](https://raw.githubusercontent.com/Spimy/yor/main/packages/cli/assets/interactive-cli.png)

### Changelog

#### v1.0.6

- Fixes an issue whereby absolute path was being used on UNIX based OS
- Fixes an issue whereby generating event component was not working

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