# @gowner/gjcli

> Various utilities

Latest version **0.0.1** (published 2024-04-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install @gowner/gjcli
pnpm add @gowner/gjcli
yarn add @gowner/gjcli
bun add @gowner/gjcli
```

Provides the command `gj`.

## 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.0.1 |
| Published | 2024-04-22 |
| First published | 2024-04-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=18.0.0 |
| Dependencies | 8 |
| Unpacked size | 20.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Gowner @GownerCode |
| Maintainers | gowner |
| Keywords | oclif |

## Links

- npm: https://www.npmjs.com/package/@gowner/gjcli
- Repository: https://github.com/GownerCode/gjcli
- Issues: https://github.com/GownerCode/gjcli/issues
- npm.io page: https://npm.io/package/@gowner/gjcli

## Dependencies (8)

- [axios](https://npm.io/package/axios.md) ^1.6.3
- [listr](https://npm.io/package/listr.md) ^0.14.3
- [openai](https://npm.io/package/openai.md) ^4.28.4
- [simple-git](https://npm.io/package/simple-git.md) ^3.24.0
- [@oclif/core](https://npm.io/package/@oclif/core.md) ^3
- [@oclif/plugin-help](https://npm.io/package/@oclif/plugin-help.md) ^6
- [@oclif/plugin-plugins](https://npm.io/package/@oclif/plugin-plugins.md) ^4
- [listr-update-renderer](https://npm.io/package/listr-update-renderer.md) ^0.5.0

## 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) — 2024-04-22
- 0.0.0 — 2024-04-19

## 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 -->
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ npm install -g @gowner/gjcli
$ gj COMMAND
running command...
$ gj (--version)
@gowner/gjcli/0.0.1 darwin-arm64 node-v20.12.2
$ gj --help [COMMAND]
USAGE
  $ gj COMMAND
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`gj ai ask [PROMPT]`](#gj-ai-ask-prompt)
* [`gj git archive REPO`](#gj-git-archive-repo)
* [`gj help [COMMAND]`](#gj-help-command)
* [`gj plugins`](#gj-plugins)
* [`gj plugins:install PLUGIN...`](#gj-pluginsinstall-plugin)
* [`gj plugins:inspect PLUGIN...`](#gj-pluginsinspect-plugin)
* [`gj plugins:install PLUGIN...`](#gj-pluginsinstall-plugin-1)
* [`gj plugins:link PLUGIN`](#gj-pluginslink-plugin)
* [`gj plugins:uninstall PLUGIN...`](#gj-pluginsuninstall-plugin)
* [`gj plugins reset`](#gj-plugins-reset)
* [`gj plugins:uninstall PLUGIN...`](#gj-pluginsuninstall-plugin-1)
* [`gj plugins:uninstall PLUGIN...`](#gj-pluginsuninstall-plugin-2)
* [`gj plugins update`](#gj-plugins-update)

## `gj ai ask [PROMPT]`

describe the command here

```
USAGE
  $ gj ai ask [PROMPT] [-s <value>]

ARGUMENTS
  PROMPT  What to say to the AI

FLAGS
  -s, --systemMessage=<value>  system message to display

DESCRIPTION
  describe the command here

EXAMPLES
  $ gj ai ask
```

_See code: [src/commands/ai/ask.ts](https://github.com/GownerCode/gjcli/blob/v0.0.1/src/commands/ai/ask.ts)_

## `gj git archive REPO`

Archive a Git repository using simple-git

```
USAGE
  $ gj git archive REPO [-a <value>]

ARGUMENTS
  REPO  Repository to archive

FLAGS
  -a, --archiveFolder=<value>  [default: N:/git-archive] Archive folder

DESCRIPTION
  Archive a Git repository using simple-git

EXAMPLES
  $ gj git archive
```

_See code: [src/commands/git/archive.ts](https://github.com/GownerCode/gjcli/blob/v0.0.1/src/commands/git/archive.ts)_

## `gj help [COMMAND]`

Display help for gj.

```
USAGE
  $ gj 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 gj.
```

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

## `gj plugins`

List installed plugins.

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

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ gj plugins
```

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

## `gj plugins:install PLUGIN...`

Installs a plugin into the CLI.

```
USAGE
  $ gj 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
  $ gj plugins add

EXAMPLES
  $ gj plugins add myplugin 

  $ gj plugins add https://github.com/someuser/someplugin

  $ gj plugins add someuser/someplugin
```

## `gj plugins:inspect PLUGIN...`

Displays installation properties of a plugin.

```
USAGE
  $ gj 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
  $ gj plugins inspect myplugin
```

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

## `gj plugins:install PLUGIN...`

Installs a plugin into the CLI.

```
USAGE
  $ gj 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
  $ gj plugins add

EXAMPLES
  $ gj plugins install myplugin 

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

  $ gj plugins install someuser/someplugin
```

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

## `gj plugins:link PLUGIN`

Links a plugin into the CLI for development.

```
USAGE
  $ gj 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
  $ gj plugins link myplugin
```

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

## `gj plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

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

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ gj plugins unlink
  $ gj plugins remove

EXAMPLES
  $ gj plugins remove myplugin
```

## `gj plugins reset`

Remove all user-installed and linked plugins.

```
USAGE
  $ gj plugins reset [--hard] [--reinstall]

FLAGS
  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
  --reinstall  Reinstall all plugins after uninstalling.
```

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

## `gj plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

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

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ gj plugins unlink
  $ gj plugins remove

EXAMPLES
  $ gj plugins uninstall myplugin
```

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

## `gj plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

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

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ gj plugins unlink
  $ gj plugins remove

EXAMPLES
  $ gj plugins unlink myplugin
```

## `gj plugins update`

Update installed plugins.

```
USAGE
  $ gj 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.3.10/src/commands/plugins/update.ts)_
<!-- commandsstop -->

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