Hereya-cli NPM

hereya-cli

Manage infrastructure components as packages.

Usage

$ npm install -g hereya-cli
$ hereya COMMAND
running command...
$ hereya (--version)
hereya-cli/0.34.0 linux-x64 node-v22.14.0
$ hereya --help [COMMAND]
USAGE
  $ hereya COMMAND
...

Commands

`hereya add PACKAGE`

Add a package to the project.

USAGE
  $ hereya add PACKAGE [--chdir <value>] [--debug] [-p <value>...]

ARGUMENTS
  PACKAGE  The package to add, specified as a GitHub repository in the format owner/repository.
           To change the registry URL, set the HEREYA_REGISTRY_URL environment variable, so that it points to
           $HEREYA_REGISTRY_URL/owner/repository.
           For local packages, use the format local://path/to/package where path/to/package is the path to the package
           on your local machine.

FLAGS
  -p, --parameter=<value>...  [default: ] parameter for the package, in the form of 'key=value'. Can be specified
                              multiple times.
      --chdir=<value>         Directory where the command will be executed.
                              If not specified, it defaults to the current working directory.
                              Alternatively, you can define the project root by setting the HEREYA_PROJECT_ROOT_DIR
                              environment variable.
      --debug                 enable debug mode

DESCRIPTION
  Add a package to the project.

EXAMPLES
  $ hereya add cloudy/docker_postgres

See code: src/commands/add/index.ts

`hereya bootstrap INFRASTRUCTURETYPE`

Install necessary resources for hereya operations in an infrastructure.

USAGE
  $ hereya bootstrap INFRASTRUCTURETYPE [-f]

ARGUMENTS
  INFRASTRUCTURETYPE  infrastructure to bootstrap. Options are local, aws

FLAGS
  -f, --force  redeploy hereya resources if already deployed

DESCRIPTION
  Install necessary resources for hereya operations in an infrastructure.

EXAMPLES
  $ hereya bootstrap aws

  $ hereya bootstrap local

See code: src/commands/bootstrap/index.ts

`hereya config get-backend`

get the current backend type

USAGE
  $ hereya config get-backend

DESCRIPTION
  get the current backend type

EXAMPLES
  $ hereya config get-backend

See code: src/commands/config/get-backend/index.ts

`hereya config use-backend TYPE`

set the current backend type

USAGE
  $ hereya config use-backend TYPE

ARGUMENTS
  TYPE  type of backend to use. Possible values: s3, local

DESCRIPTION
  set the current backend type

EXAMPLES
  $ hereya config use-backend s3

  $ hereya config use-backend local

See code: src/commands/config/use-backend/index.ts

`hereya deploy`

Deploy a hereya project using the project deployment package

USAGE
  $ hereya deploy -w <value> [--chdir <value>] [--debug]

FLAGS
  -w, --workspace=<value>  (required) name of the workspace to deploy the packages for
      --chdir=<value>      Directory where the command will be executed.
                           If not specified, it defaults to the current working directory.
                           Alternatively, you can define the project root by setting the HEREYA_PROJECT_ROOT_DIR
                           environment variable.
      --debug              enable debug mode

DESCRIPTION
  Deploy a hereya project using the project deployment package

EXAMPLES
  $ hereya deploy

See code: src/commands/deploy/index.ts

`hereya down`

Destroy all packages in the project.

USAGE
  $ hereya down [--chdir <value>] [--debug] [--deploy] [-s <value>...] [-w <value>]

FLAGS
  -s, --select=<value>...  [default: ] select the packages to destroy
  -w, --workspace=<value>  name of the workspace to destroy the packages for
      --chdir=<value>      Directory where the command will be executed.
                           If not specified, it defaults to the current working directory.
                           Alternatively, you can define the project root by setting the HEREYA_PROJECT_ROOT_DIR
                           environment variable.
      --debug              enable debug mode
      --deploy             destroy deployment companion packages

DESCRIPTION
  Destroy all packages in the project.

EXAMPLES
  $ hereya down

See code: src/commands/down/index.ts

`hereya env [NAME]`

Print project environment variables.

USAGE
  $ hereya env [NAME] [--chdir <value>] [-l] [-w <value>]

ARGUMENTS
  NAME  name of the env to display

FLAGS
  -l, --list               list only the env vars without values
  -w, --workspace=<value>  name of the workspace to print the env vars for
      --chdir=<value>      project root directory

DESCRIPTION
  Print project environment variables.

EXAMPLES
  $ hereya env

  $ hereya env myEnv

  $ hereya env -w dev

  $ hereya env -w dev -l

See code: src/commands/env/index.ts

`hereya env set [NAME]`

Set an user-defined environment variable for the project

USAGE
  $ hereya env set [NAME] -v <value> [--chdir <value>] [-w <value>]

ARGUMENTS
  NAME  name of the environment variable to set

FLAGS
  -v, --value=<value>      (required) value of the environment variable
  -w, --workspace=<value>  name of the workspace to print the env vars for
      --chdir=<value>      project root directory

DESCRIPTION
  Set an user-defined environment variable for the project

EXAMPLES
  $ hereya env set FOO -v bar

  $ hereya env set FOO -v bar -w dev

See code: src/commands/env/set/index.ts

`hereya help [COMMAND]`

Display help for hereya.

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

See code: @oclif/plugin-help

`hereya init PROJECT`

Initialize hereya in a project directory.

USAGE
  $ hereya init PROJECT -w <value> [--chdir <value>]

ARGUMENTS
  PROJECT  project name

FLAGS
  -w, --workspace=<value>  (required) workspace to set as default
      --chdir=<value>      directory to run command in

DESCRIPTION
  Initialize hereya in a project directory.

EXAMPLES
  $ hereya init myProject -w=defaultWorkspace

  $ hereya init myProject -w=defaultWorkspace --chdir=./myProject

See code: src/commands/init/index.ts

`hereya remove PACKAGE`

Remove a package from the project.

USAGE
  $ hereya remove PACKAGE [--chdir <value>] [--debug]

ARGUMENTS
  PACKAGE  Remove a previously added package.

FLAGS
  --chdir=<value>  Directory where the command will be executed.
                   If not specified, it defaults to the current working directory.
                   Alternatively, you can define the project root by setting the HEREYA_PROJECT_ROOT_DIR environment
                   variable.
  --debug          enable debug mode

DESCRIPTION
  Remove a package from the project.

EXAMPLES
  $ hereya remove cloudy/docker_postgres

See code: src/commands/remove/index.ts

`hereya run CMD`

Run a command with hereya env vars.

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

ARGUMENTS
  CMD...  command to run

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

DESCRIPTION
  Run a command with hereya env vars.

EXAMPLES
  $ hereya run -- npm run dev

  $ hereya run -w uat -- node index.js

See code: src/commands/run/index.ts

`hereya unbootstrap INFRASTRUCTURETYPE`

Uninstall hereya resources deployed with bootstrap command.

USAGE
  $ hereya unbootstrap INFRASTRUCTURETYPE [-f]

ARGUMENTS
  INFRASTRUCTURETYPE  infrastructure to unbootstrap. Options are local, aws

FLAGS
  -f, --force  try to delete hereya resources even if not deployed

DESCRIPTION
  Uninstall hereya resources deployed with bootstrap command.

EXAMPLES
  $ hereya unbootstrap aws

  $ hereya unbootstrap local

See code: src/commands/unbootstrap/index.ts

`hereya undeploy`

Undeploy a hereya project by removing all resources.

USAGE
  $ hereya undeploy -w <value> [--chdir <value>] [--debug]

FLAGS
  -w, --workspace=<value>  (required) name of the workspace to undeploy the packages for
      --chdir=<value>      Directory where the command will be executed.
                           If not specified, it defaults to the current working directory.
                           Alternatively, you can define the project root by setting the HEREYA_PROJECT_ROOT_DIR
                           environment variable.
      --debug              enable debug mode

DESCRIPTION
  Undeploy a hereya project by removing all resources.

EXAMPLES
  $ hereya undeploy

See code: src/commands/undeploy/index.ts

`hereya up`

Provision all packages in the project.

USAGE
  $ hereya up [--chdir <value>] [--debug] [--deploy] [-s <value>...] [-w <value>]

FLAGS
  -s, --select=<value>...  [default: ] select the packages to provision
  -w, --workspace=<value>  name of the workspace to install the packages for
      --chdir=<value>      Directory where the command will be executed.
                           If not specified, it defaults to the current working directory.
                           Alternatively, you can define the project root by setting the HEREYA_PROJECT_ROOT_DIR
                           environment variable.
      --debug              enable debug mode
      --deploy             provision deployment companion packages

DESCRIPTION
  Provision all packages in the project.

EXAMPLES
  $ hereya up

See code: src/commands/up/index.ts

`hereya workspace create NAME`

Create a new workspace if it does not exist.

USAGE
  $ hereya workspace create NAME [--mirror <value>]

ARGUMENTS
  NAME  name of the workspace to create

FLAGS
  --mirror=<value>  workspace to mirror

DESCRIPTION
  Create a new workspace if it does not exist.

EXAMPLES
  $ hereya workspace create dev

See code: src/commands/workspace/create/index.ts

`hereya workspace delete NAME`

Delete a workspace if it exists.

USAGE
  $ hereya workspace delete NAME

ARGUMENTS
  NAME  name of the workspace to delete

DESCRIPTION
  Delete a workspace if it exists.

EXAMPLES
  $ hereya workspace delete dev

See code: src/commands/workspace/delete/index.ts

`hereya workspace env [NAME]`

Print workspace env vars.

USAGE
  $ hereya workspace env [NAME] -w <value> [-l]

ARGUMENTS
  NAME  name of the env to display

FLAGS
  -l, --list               list only the env vars without values
  -w, --workspace=<value>  (required) name of the workspace to print env vars for

DESCRIPTION
  Print workspace env vars.

EXAMPLES
  $ hereya workspace env -w dev

  $ hereya workspace env myEnv -w dev

See code: src/commands/workspace/env/index.ts

`hereya workspace env set`

set an env var for a workspace

USAGE
  $ hereya workspace env set -i <value> -n <value> -v <value> -w <value> [-s]

FLAGS
  -i, --infra=<value>      (required) the infrastructure to store the env var in
  -n, --name=<value>       (required) name of the env var to set
  -s, --sensitive          whether the env var is sensitive
  -v, --value=<value>      (required) value of the env var to set
  -w, --workspace=<value>  (required) name of the workspace to set an env var for

DESCRIPTION
  set an env var for a workspace

EXAMPLES
  $ hereya workspace env set -w my-workspace -n myVar -v my-value -i aws -s

See code: src/commands/workspace/env/set/index.ts

`hereya workspace env unset`

unset an env var for a workspace

USAGE
  $ hereya workspace env unset -n <value> -w <value>

FLAGS
  -n, --name=<value>       (required) name of the env var to unset
  -w, --workspace=<value>  (required) name of the workspace to unset an env var for

DESCRIPTION
  unset an env var for a workspace

EXAMPLES
  $ hereya workspace env unset -w my-workspace -n myVar

See code: src/commands/workspace/env/unset/index.ts

`hereya workspace install PACKAGE`

Add a package to the workspace.

USAGE
  $ hereya workspace install PACKAGE -w <value> [--debug] [-p <value>...] [-f <value>]

ARGUMENTS
  PACKAGE  The package to add. Packages are gitHub repositories. Use the format owner/repository

FLAGS
  -f, --parameter-file=<value>  path to a file containing parameters for the package
  -p, --parameter=<value>...    [default: ] parameter for the package, in the form of 'key=value'. Can be specified
                                multiple times.
  -w, --workspace=<value>       (required) name of the workspace to add the package to
      --debug                   enable debug mode

DESCRIPTION
  Add a package to the workspace.

EXAMPLES
  $ hereya workspace install hereya/aws-cognito

See code: src/commands/workspace/install/index.ts

`hereya workspace list`

List workspaces.

USAGE
  $ hereya workspace list

DESCRIPTION
  List workspaces.

EXAMPLES
  $ hereya workspace list

See code: src/commands/workspace/list/index.ts

`hereya workspace uninstall PACKAGE`

Remove a package from a workspace.

USAGE
  $ hereya workspace uninstall PACKAGE -w <value> [--debug] [-p <value>...] [-f <value>]

ARGUMENTS
  PACKAGE  The package to remove. Packages are gitHub repositories. Use the format owner/repository

FLAGS
  -f, --parameter-file=<value>  path to a file containing parameters for the package
  -p, --parameter=<value>...    [default: ] parameter for the package, in the form of 'key=value'. Can be specified
                                multiple times.
  -w, --workspace=<value>       (required) name of the workspace to remove the package from
      --debug                   enable debug mode

DESCRIPTION
  Remove a package from a workspace.

EXAMPLES
  $ hereya workspace uninstall hereya/aws-cognito

See code: src/commands/workspace/uninstall/index.ts

oclif