npm package: @hereya/cli
Description: Package manager for infrastructure libraries
Author: Jonatan Sombié @stomybexy
Latest version: 0.9.2

hereya-cli
=================

Package manager for infrastructure libraries

[![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 @hereya/cli
$ hereya COMMAND
running command...
$ hereya (--version)
@hereya/cli/0.9.2 linux-x64 node-v20.12.2
$ hereya --help [COMMAND]
USAGE
  $ hereya COMMAND
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`hereya add PACKAGE`](#hereya-add-package)
* [`hereya cdk exec NAME`](#hereya-cdk-exec-name)
* [`hereya env`](#hereya-env)
* [`hereya help [COMMANDS]`](#hereya-help-commands)
* [`hereya install`](#hereya-install)
* [`hereya plugins`](#hereya-plugins)
* [`hereya plugins:install PLUGIN...`](#hereya-pluginsinstall-plugin)
* [`hereya plugins:inspect PLUGIN...`](#hereya-pluginsinspect-plugin)
* [`hereya plugins:install PLUGIN...`](#hereya-pluginsinstall-plugin-1)
* [`hereya plugins:link PLUGIN`](#hereya-pluginslink-plugin)
* [`hereya plugins:uninstall PLUGIN...`](#hereya-pluginsuninstall-plugin)
* [`hereya plugins:uninstall PLUGIN...`](#hereya-pluginsuninstall-plugin-1)
* [`hereya plugins:uninstall PLUGIN...`](#hereya-pluginsuninstall-plugin-2)
* [`hereya plugins update`](#hereya-plugins-update)
* [`hereya project init NAME`](#hereya-project-init-name)
* [`hereya remove PACKAGE`](#hereya-remove-package)
* [`hereya run CMD`](#hereya-run-cmd)
* [`hereya uninstall`](#hereya-uninstall)
* [`hereya workspace add MODULE`](#hereya-workspace-add-module)
* [`hereya workspace create NAME`](#hereya-workspace-create-name)
* [`hereya workspace remove MODULE`](#hereya-workspace-remove-module)

## `hereya add PACKAGE`

add a package to the project

```
USAGE
  $ hereya add PACKAGE [-w <value>] [-f] [--parameters <value>]

ARGUMENTS
  PACKAGE  name of the package to add

FLAGS
  -f, --force              force redeployment of the module
  -w, --workspace=<value>  name of the workspace to add the package to
  --parameters=<value>...  parameters for the package, in the form of 'key=value'

DESCRIPTION
  add a package to the project

EXAMPLES
  $ hereya add
```

_See code: [src/commands/add.ts](https://github.com/hereya/cli/blob/v0.9.2/src/commands/add.ts)_

## `hereya cdk exec NAME`

deploy a CDK stack

```
USAGE
  $ hereya cdk exec NAME [-w <value>] [-p <value>] [--parameters <value>] [--destroy]

ARGUMENTS
  NAME  name of the package or module to add

FLAGS
  -p, --project=<value>    name of the project to add the package to
  -w, --workspace=<value>  name of the workspace to add the module/package to
  --destroy                destroy the stack
  --parameters=<value>...  parameters for the module, in the form of 'key=value'

DESCRIPTION
  deploy a CDK stack

EXAMPLES
  $ hereya cdk exec -w dev mymodule
```

_See code: [src/commands/cdk/exec.ts](https://github.com/hereya/cli/blob/v0.9.2/src/commands/cdk/exec.ts)_

## `hereya env`

describe the command here

```
USAGE
  $ hereya env [-w <value>]

FLAGS
  -w, --workspace=<value>  name of the workspace to run the command in

DESCRIPTION
  describe the command here

EXAMPLES
  $ hereya env
```

_See code: [src/commands/env.ts](https://github.com/hereya/cli/blob/v0.9.2/src/commands/env.ts)_

## `hereya help [COMMANDS]`

Display help for hereya.

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

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

## `hereya install`

deploy resources to support hereya operations in AWS

```
USAGE
  $ hereya install

DESCRIPTION
  deploy resources to support hereya operations in AWS

EXAMPLES
  $ hereya install
```

_See code: [src/commands/install.ts](https://github.com/hereya/cli/blob/v0.9.2/src/commands/install.ts)_

## `hereya plugins`

List installed plugins.

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

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ hereya plugins
```

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

## `hereya plugins:install PLUGIN...`

Installs a plugin into the CLI.

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

EXAMPLES
  $ hereya plugins:install myplugin 

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

  $ hereya plugins:install someuser/someplugin
```

## `hereya plugins:inspect PLUGIN...`

Displays installation properties of a plugin.

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

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

## `hereya plugins:install PLUGIN...`

Installs a plugin into the CLI.

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

EXAMPLES
  $ hereya plugins:install myplugin 

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

  $ hereya plugins:install someuser/someplugin
```

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

## `hereya plugins:link PLUGIN`

Links a plugin into the CLI for development.

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

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

## `hereya plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

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

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ hereya plugins unlink
  $ hereya plugins remove
```

## `hereya plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

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

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ hereya plugins unlink
  $ hereya plugins remove
```

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

## `hereya plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

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

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ hereya plugins unlink
  $ hereya plugins remove
```

## `hereya plugins update`

Update installed plugins.

```
USAGE
  $ hereya 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/v3.9.4/src/commands/plugins/update.ts)_

## `hereya project init NAME`

initialize a new project

```
USAGE
  $ hereya project init NAME -w <value>

ARGUMENTS
  NAME  name of the project to create

FLAGS
  -w, --workspace=<value>  (required) name of the workspace to set as current

DESCRIPTION
  initialize a new project

EXAMPLES
  $ hereya project init
```

_See code: [src/commands/project/init.ts](https://github.com/hereya/cli/blob/v0.9.2/src/commands/project/init.ts)_

## `hereya remove PACKAGE`

describe the command here

```
USAGE
  $ hereya remove PACKAGE [-w <value>]

ARGUMENTS
  PACKAGE  name of the package to remove

FLAGS
  -w, --workspace=<value>  name of the workspace to add the package to

DESCRIPTION
  describe the command here

EXAMPLES
  $ hereya remove
```

_See code: [src/commands/remove.ts](https://github.com/hereya/cli/blob/v0.9.2/src/commands/remove.ts)_

## `hereya run CMD`

describe the command here

```
USAGE
  $ hereya run CMD [-w <value>]

ARGUMENTS
  CMD  command to run

FLAGS
  -w, --workspace=<value>  name of the workspace to run the command in

DESCRIPTION
  describe the command here

EXAMPLES
  $ hereya run
```

_See code: [src/commands/run.ts](https://github.com/hereya/cli/blob/v0.9.2/src/commands/run.ts)_

## `hereya uninstall`

remove hereya resources from your AWS account

```
USAGE
  $ hereya uninstall

DESCRIPTION
  remove hereya resources from your AWS account

EXAMPLES
  $ hereya uninstall
```

_See code: [src/commands/uninstall.ts](https://github.com/hereya/cli/blob/v0.9.2/src/commands/uninstall.ts)_

## `hereya workspace add MODULE`

add a module to a workspace

```
USAGE
  $ hereya workspace add MODULE -w <value> [-f] [--parameters <value>]

ARGUMENTS
  MODULE  name of the module to add

FLAGS
  -f, --force              force redeployment of the module
  -w, --workspace=<value>  (required) name of the workspace to add the module to
  --parameters=<value>...  parameters for the module, in the form of 'key=value'

DESCRIPTION
  add a module to a workspace

EXAMPLES
  $ hereya workspace add -w dev mymodule

  $ hereya workspace add -w dev mymodule --parameters foo=bar --parameters baz=qux
```

_See code: [src/commands/workspace/add.ts](https://github.com/hereya/cli/blob/v0.9.2/src/commands/workspace/add.ts)_

## `hereya workspace create NAME`

create a new workspace

```
USAGE
  $ hereya workspace create NAME

ARGUMENTS
  NAME  name of the workspace to create

DESCRIPTION
  create a new workspace

EXAMPLES
  $ hereya workspace create dev
```

_See code: [src/commands/workspace/create.ts](https://github.com/hereya/cli/blob/v0.9.2/src/commands/workspace/create.ts)_

## `hereya workspace remove MODULE`

remove a module from a workspace

```
USAGE
  $ hereya workspace remove MODULE -w <value> [--parameters <value>]

ARGUMENTS
  MODULE  name of the module to add

FLAGS
  -w, --workspace=<value>  (required) name of the workspace to remove the module from
  --parameters=<value>...  parameters for the module, in the form of 'key=value'

DESCRIPTION
  remove a module from a workspace

EXAMPLES
  $ hereya workspace remove mymodule -w dev
```

_See code: [src/commands/workspace/remove.ts](https://github.com/hereya/cli/blob/v0.9.2/src/commands/workspace/remove.ts)_
<!-- commandsstop -->