# @clai-pkg/cli

> CLI ❤️ AI

Latest version **0.0.1** (published 2023-11-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install @clai-pkg/cli
pnpm add @clai-pkg/cli
yarn add @clai-pkg/cli
bun add @clai-pkg/cli
```

Provides the command `clai`.

## Health

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

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

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2023-11-15 |
| First published | 2023-11-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Node | >=18.0.0 |
| Dependencies | 3 |
| Unpacked size | 14.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | taochunsheng |
| Maintainers | cs-tao |
| Keywords | oclif |

## Links

- npm: https://www.npmjs.com/package/@clai-pkg/cli
- Repository: https://github.com/CS-Tao/CS-Tao
- Issues: https://github.com/CS-Tao/CS-Tao/issues
- npm.io page: https://npm.io/package/@clai-pkg/cli

## Dependencies (3)

- [@oclif/core](https://npm.io/package/@oclif/core.md) ^3
- [@oclif/plugin-help](https://npm.io/package/@oclif/plugin-help.md) ^5
- [@oclif/plugin-plugins](https://npm.io/package/@oclif/plugin-plugins.md) ^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

- 0.0.1 (latest) — 2023-11-15

## README

# oclif-hello-world

oclif example Hello World CLI

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![CircleCI](https://circleci.com/gh/oclif/hello-world/tree/main.svg?style=shield)](https://circleci.com/gh/oclif/hello-world/tree/main)
[![GitHub license](https://img.shields.io/github/license/oclif/hello-world)](https://github.com/oclif/hello-world/blob/main/LICENSE)

<!-- toc -->
* [oclif-hello-world](#oclif-hello-world)
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->

# Usage

<!-- usage -->
```sh-session
$ npm install -g @clai-pkg/cli
$ clai COMMAND
running command...
$ clai (--version)
@clai-pkg/cli/0.0.1 darwin-arm64 node-v18.17.1
$ clai --help [COMMAND]
USAGE
  $ clai COMMAND
...
```
<!-- usagestop -->

# Commands

<!-- commands -->
* [`clai hello PERSON`](#clai-hello-person)
* [`clai hello world`](#clai-hello-world)
* [`clai help [COMMANDS]`](#clai-help-commands)
* [`clai plugins`](#clai-plugins)
* [`clai plugins:install PLUGIN...`](#clai-pluginsinstall-plugin)
* [`clai plugins:inspect PLUGIN...`](#clai-pluginsinspect-plugin)
* [`clai plugins:install PLUGIN...`](#clai-pluginsinstall-plugin-1)
* [`clai plugins:link PLUGIN`](#clai-pluginslink-plugin)
* [`clai plugins:uninstall PLUGIN...`](#clai-pluginsuninstall-plugin)
* [`clai plugins reset`](#clai-plugins-reset)
* [`clai plugins:uninstall PLUGIN...`](#clai-pluginsuninstall-plugin-1)
* [`clai plugins:uninstall PLUGIN...`](#clai-pluginsuninstall-plugin-2)
* [`clai plugins update`](#clai-plugins-update)

## `clai hello PERSON`

Say hello

```
USAGE
  $ clai hello PERSON -f <value>

ARGUMENTS
  PERSON  Person to say hello to

FLAGS
  -f, --from=<value>  (required) Who is saying hello

DESCRIPTION
  Say hello

EXAMPLES
  $ oex hello friend --from oclif
  hello friend from oclif! (./src/commands/hello/index.ts)
```

_See code: [src/commands/hello/index.ts](https://github.com/CS-Tao/CS-Tao/blob/v0.0.1/src/commands/hello/index.ts)_

## `clai hello world`

Say hello world

```
USAGE
  $ clai hello world

DESCRIPTION
  Say hello world

EXAMPLES
  $ clai hello world
  hello world! (./src/commands/hello/world.ts)
```

_See code: [src/commands/hello/world.ts](https://github.com/CS-Tao/CS-Tao/blob/v0.0.1/src/commands/hello/world.ts)_

## `clai help [COMMANDS]`

Display help for clai.

```
USAGE
  $ clai help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

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

DESCRIPTION
  Display help for clai.
```

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

## `clai plugins`

List installed plugins.

```
USAGE
  $ clai plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ clai plugins
```

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

## `clai plugins:install PLUGIN...`

Installs a plugin into the CLI.

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

ARGUMENTS
  PLUGIN  Plugin to install.

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

GLOBAL FLAGS
  --json  Format output as json.

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
  $ clai plugins add

EXAMPLES
  $ clai plugins:install myplugin 

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

  $ clai plugins:install someuser/someplugin
```

## `clai plugins:inspect PLUGIN...`

Displays installation properties of a plugin.

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

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

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

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ clai plugins:inspect myplugin
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.1.5/src/commands/plugins/inspect.ts)_

## `clai plugins:install PLUGIN...`

Installs a plugin into the CLI.

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

ARGUMENTS
  PLUGIN  Plugin to install.

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

GLOBAL FLAGS
  --json  Format output as json.

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
  $ clai plugins add

EXAMPLES
  $ clai plugins:install myplugin 

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

  $ clai plugins:install someuser/someplugin
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.1.5/src/commands/plugins/install.ts)_

## `clai plugins:link PLUGIN`

Links a plugin into the CLI for development.

```
USAGE
  $ clai plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help      Show CLI help.
  -v, --verbose
  --[no-]install  Install dependencies after linking the plugin.

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
  $ clai plugins:link myplugin
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.1.5/src/commands/plugins/link.ts)_

## `clai plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

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

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ clai plugins unlink
  $ clai plugins remove
```

## `clai plugins reset`

Remove all user-installed and linked plugins.

```
USAGE
  $ clai plugins reset
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.1.5/src/commands/plugins/reset.ts)_

## `clai plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

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

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ clai plugins unlink
  $ clai plugins remove
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.1.5/src/commands/plugins/uninstall.ts)_

## `clai plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

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

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ clai plugins unlink
  $ clai plugins remove
```

## `clai plugins update`

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.1.5/src/commands/plugins/update.ts)_
<!-- commandsstop -->

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