oclif-hello-world
=================

oclif example Hello World CLI

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/oclif-hello-world.svg)](https://npmjs.org/package/oclif-hello-world)
[![CircleCI](https://circleci.com/gh/oclif/hello-world/tree/main.svg?style=shield)](https://circleci.com/gh/oclif/hello-world/tree/main)
[![Downloads/week](https://img.shields.io/npm/dw/oclif-hello-world.svg)](https://npmjs.org/package/oclif-hello-world)
[![License](https://img.shields.io/npm/l/oclif-hello-world.svg)](https://github.com/oclif/hello-world/blob/main/package.json)

<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ npm install -g @hexdigital/cli
$ hex COMMAND
running command...
$ hex (--version)
@hexdigital/cli/0.0.3 darwin-arm64 node-v16.16.0
$ hex --help [COMMAND]
USAGE
  $ hex COMMAND
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`hex autocomplete [SHELL]`](#hex-autocomplete-shell)
* [`hex help [COMMAND]`](#hex-help-command)
* [`hex notion open [FILE]`](#hex-notion-open-file)
* [`hex plugins`](#hex-plugins)
* [`hex plugins:install PLUGIN...`](#hex-pluginsinstall-plugin)
* [`hex plugins:inspect PLUGIN...`](#hex-pluginsinspect-plugin)
* [`hex plugins:install PLUGIN...`](#hex-pluginsinstall-plugin-1)
* [`hex plugins:link PLUGIN`](#hex-pluginslink-plugin)
* [`hex plugins:uninstall PLUGIN...`](#hex-pluginsuninstall-plugin)
* [`hex plugins:uninstall PLUGIN...`](#hex-pluginsuninstall-plugin-1)
* [`hex plugins:uninstall PLUGIN...`](#hex-pluginsuninstall-plugin-2)
* [`hex plugins update`](#hex-plugins-update)
* [`hex project open [CLIENTNAME]`](#hex-project-open-clientname)

## `hex autocomplete [SHELL]`

display autocomplete installation instructions

```
USAGE
  $ hex autocomplete [SHELL] [-r]

ARGUMENTS
  SHELL  shell type

FLAGS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

DESCRIPTION
  display autocomplete installation instructions

EXAMPLES
  $ hex autocomplete

  $ hex autocomplete bash

  $ hex autocomplete zsh

  $ hex autocomplete --refresh-cache
```

_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v1.3.0/src/commands/autocomplete/index.ts)_

## `hex help [COMMAND]`

Display help for hex.

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

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

## `hex notion open [FILE]`

describe the command here

```
USAGE
  $ hex notion open [FILE] [-n <value>] [-f]

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

DESCRIPTION
  describe the command here

EXAMPLES
  $ hex notion open
```

## `hex plugins`

List installed plugins.

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

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ hex plugins
```

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

## `hex plugins:install PLUGIN...`

Installs a plugin into the CLI.

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

EXAMPLES
  $ hex plugins:install myplugin 

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

  $ hex plugins:install someuser/someplugin
```

## `hex plugins:inspect PLUGIN...`

Displays installation properties of a plugin.

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

## `hex plugins:install PLUGIN...`

Installs a plugin into the CLI.

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

EXAMPLES
  $ hex plugins:install myplugin 

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

  $ hex plugins:install someuser/someplugin
```

## `hex plugins:link PLUGIN`

Links a plugin into the CLI for development.

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

## `hex plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

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

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ hex plugins unlink
  $ hex plugins remove
```

## `hex plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

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

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ hex plugins unlink
  $ hex plugins remove
```

## `hex plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

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

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ hex plugins unlink
  $ hex plugins remove
```

## `hex plugins update`

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.
```

## `hex project open [CLIENTNAME]`

Opens the project management tool for this project

```
USAGE
  $ hex project open [CLIENTNAME]

DESCRIPTION
  Opens the project management tool for this project

EXAMPLES
  $ hex project open
```
<!-- commandsstop -->