# @gochewy/cli

> CLI to create and manage Chewy Stack projects.

Latest version **0.1.1-beta.2** (published 2023-01-17) · AGPL-3.0 license · 0 weekly downloads

## Install

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

Provides the command `chewy`.

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1-beta.2 |
| Published | 2023-01-17 |
| First published | 2022-12-15 |
| Weekly downloads | 0 |
| License | AGPL-3.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=12.0.0 |
| Dependencies | 8 |
| Unpacked size | 58.5 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Ephemere Creative Ltd |
| Maintainers | chewy-dev-service, ec-raphael, swarnjit |
| Keywords | oclif |

## Links

- npm: https://www.npmjs.com/package/@gochewy/cli
- Repository: https://github.com/gochewy/cli
- Issues: https://github.com/gochewy/cli/issues
- npm.io page: https://npm.io/package/@gochewy/cli

## Dependencies (8)

- [zod](https://npm.io/package/zod.md) ^3.20.2
- [inquirer](https://npm.io/package/inquirer.md) ^8
- [colorette](https://npm.io/package/colorette.md) ^2.0.19
- [@oclif/core](https://npm.io/package/@oclif/core.md) ^1.21.0
- [@gochewy/lib](https://npm.io/package/@gochewy/lib.md) ^0.1.1-beta.13
- [@types/inquirer](https://npm.io/package/@types/inquirer.md) ^8
- [@oclif/plugin-help](https://npm.io/package/@oclif/plugin-help.md) ^5
- [@oclif/plugin-plugins](https://npm.io/package/@oclif/plugin-plugins.md) ^2.1.7

## 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

- 0.1.1-beta.2 (latest) — 2023-01-17
- 0.1.1-beta.1 — 2022-12-15
- 0.1.1 — 2022-12-15

## README

Chewy CLI
=================

Welcome to the Chewy Stack. This CLI is probably what you'll want to get started!

[![chewy](https://img.shields.io/badge/chewy-get%20started-brightgreen.svg)](https://gochewy.io)
[![Version](https://img.shields.io/npm/v/@gochewy/cli.svg)](https://www.npmjs.com/package/@gochewy/cli)
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/gochewy/cli/onRelease.yml)](https://github.com/gochewy/cli)
[![Downloads/week](https://img.shields.io/npm/dw/@gochewy/cli.svg)](https://npmjs.org/package/@gochewy/cli)
[![License](https://img.shields.io/npm/l/@gochewy/cli.svg)](https://www.npmjs.com/package/@gochewy/cli)

<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ npm install -g @gochewy/cli
$ chewy COMMAND
running command...
$ chewy (--version)
@gochewy/cli/0.1.1-beta.2 linux-x64 node-v16.19.0
$ chewy --help [COMMAND]
USAGE
  $ chewy COMMAND
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`chewy c`](#chewy-c)
* [`chewy command`](#chewy-command)
* [`chewy create [FILE]`](#chewy-create-file)
* [`chewy dev [FILE]`](#chewy-dev-file)
* [`chewy dev start [FILE]`](#chewy-dev-start-file)
* [`chewy help [COMMAND]`](#chewy-help-command)
* [`chewy init [NAME]`](#chewy-init-name)
* [`chewy install [FILE]`](#chewy-install-file)
* [`chewy plugins`](#chewy-plugins)
* [`chewy plugins:install PLUGIN...`](#chewy-pluginsinstall-plugin)
* [`chewy plugins:inspect PLUGIN...`](#chewy-pluginsinspect-plugin)
* [`chewy plugins:install PLUGIN...`](#chewy-pluginsinstall-plugin-1)
* [`chewy plugins:link PLUGIN`](#chewy-pluginslink-plugin)
* [`chewy plugins:uninstall PLUGIN...`](#chewy-pluginsuninstall-plugin)
* [`chewy plugins:uninstall PLUGIN...`](#chewy-pluginsuninstall-plugin-1)
* [`chewy plugins:uninstall PLUGIN...`](#chewy-pluginsuninstall-plugin-2)
* [`chewy plugins update`](#chewy-plugins-update)

## `chewy c`

execute a component command

```
USAGE
  $ chewy c

DESCRIPTION
  execute a component command

ALIASES
  $ chewy c

EXAMPLES
  $ chewy c nextjs init
```

## `chewy command`

execute a component command

```
USAGE
  $ chewy command

DESCRIPTION
  execute a component command

ALIASES
  $ chewy c

EXAMPLES
  $ chewy command nextjs init
```

_See code: [dist/commands/command.ts](https://github.com/gochewy/cli/blob/v0.1.1-beta.2/dist/commands/command.ts)_

## `chewy create [FILE]`

describe the command here

```
USAGE
  $ chewy create [FILE] [-n <value>] [-f]

FLAGS
  -f, --force
  -n, --name=<value>  name to print

DESCRIPTION
  describe the command here

EXAMPLES
  $ chewy create
```

_See code: [dist/commands/create/index.ts](https://github.com/gochewy/cli/blob/v0.1.1-beta.2/dist/commands/create/index.ts)_

## `chewy dev [FILE]`

describe the command here

```
USAGE
  $ chewy dev [FILE] [-n <value>] [-f]

FLAGS
  -f, --force
  -n, --name=<value>  name to print

DESCRIPTION
  describe the command here

EXAMPLES
  $ chewy dev
```

_See code: [dist/commands/dev/index.ts](https://github.com/gochewy/cli/blob/v0.1.1-beta.2/dist/commands/dev/index.ts)_

## `chewy dev start [FILE]`

describe the command here

```
USAGE
  $ chewy dev start [FILE] [-n <value>] [-f]

FLAGS
  -f, --force
  -n, --name=<value>  name to print

DESCRIPTION
  describe the command here

EXAMPLES
  $ chewy dev start
```

## `chewy help [COMMAND]`

Display help for chewy.

```
USAGE
  $ chewy help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for chewy.
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.20/src/commands/help.ts)_

## `chewy init [NAME]`

Command to initialize a chewy project.

```
USAGE
  $ chewy init [NAME] [-n <value>] [-p <value>] [-n]

ARGUMENTS
  NAME  kebab-cased name of project, which will also be install directory

FLAGS
  -n, --name=<value>    project name (kebab-cased)
  -n, --nonInteractive  run in non-interactive mode
  -p, --path=<value>    path to install to

DESCRIPTION
  Command to initialize a chewy project.

EXAMPLES
  $ chewy init
```

_See code: [dist/commands/init/index.ts](https://github.com/gochewy/cli/blob/v0.1.1-beta.2/dist/commands/init/index.ts)_

## `chewy install [FILE]`

describe the command here

```
USAGE
  $ chewy install [FILE] [-n <value>] [-f]

FLAGS
  -f, --force
  -n, --name=<value>  name to print

DESCRIPTION
  describe the command here

EXAMPLES
  $ chewy install
```

_See code: [dist/commands/install/index.ts](https://github.com/gochewy/cli/blob/v0.1.1-beta.2/dist/commands/install/index.ts)_

## `chewy plugins`

List installed plugins.

```
USAGE
  $ chewy plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ chewy plugins
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.9/src/commands/plugins/index.ts)_

## `chewy plugins:install PLUGIN...`

Installs a plugin into the CLI.

```
USAGE
  $ chewy plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ chewy plugins add

EXAMPLES
  $ chewy plugins:install myplugin 

  $ chewy plugins:install https://github.com/someuser/someplugin

  $ chewy plugins:install someuser/someplugin
```

## `chewy plugins:inspect PLUGIN...`

Displays installation properties of a plugin.

```
USAGE
  $ chewy plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ chewy plugins:inspect myplugin
```

## `chewy plugins:install PLUGIN...`

Installs a plugin into the CLI.

```
USAGE
  $ chewy plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ chewy plugins add

EXAMPLES
  $ chewy plugins:install myplugin 

  $ chewy plugins:install https://github.com/someuser/someplugin

  $ chewy plugins:install someuser/someplugin
```

## `chewy plugins:link PLUGIN`

Links a plugin into the CLI for development.

```
USAGE
  $ chewy plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Links a plugin into the CLI for development.
  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
  command will override the user-installed or core plugin implementation. This is useful for development work.


EXAMPLES
  $ chewy plugins:link myplugin
```

## `chewy plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

```
USAGE
  $ chewy plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ chewy plugins unlink
  $ chewy plugins remove
```

## `chewy plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

```
USAGE
  $ chewy plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ chewy plugins unlink
  $ chewy plugins remove
```

## `chewy plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

```
USAGE
  $ chewy plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ chewy plugins unlink
  $ chewy plugins remove
```

## `chewy plugins update`

Update installed plugins.

```
USAGE
  $ chewy plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.
```
<!-- commandsstop -->

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