hereya-cli

The package manager for infrastructure resources.

• Usage
• Commands

Usage

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

Commands

• hereya add PACKAGE
• hereya bootstrap INFRASTRUCTURETYPE
• hereya clone PROJECT
• hereya config export-backend [FILE]
• hereya config get-backend
• hereya config import-backend FILE
• hereya config use-backend TYPE
• hereya delete-state
• hereya deploy
• hereya devenv config
• hereya devenv install
• hereya devenv project init PROJECT
• hereya devenv project uninit PROJECT
• hereya devenv ssh
• hereya devenv uninstall
• hereya doc PACKAGE
• hereya docker run IMAGE
• hereya down
• hereya env [NAME]
• hereya env set [NAME]
• hereya executor start
• hereya flow add PACKAGE
• hereya flow docker run IMAGE
• hereya flow down
• hereya flow env [NAME]
• hereya flow provid PACKAGE
• hereya flow remove PACKAGE
• hereya flow run CMD
• hereya flow up
• hereya help [COMMAND]
• hereya import PACKAGE
• hereya init PROJECT
• hereya list
• hereya login [URL]
• hereya logout
• hereya provid PACKAGE
• hereya publish
• hereya remove PACKAGE
• hereya run CMD
• hereya search QUERY
• hereya unbootstrap INFRASTRUCTURETYPE
• hereya undeploy
• hereya uninit PROJECT
• hereya up
• hereya update [VERSION]
• hereya workspace create NAME
• hereya workspace delete NAME
• hereya workspace env [NAME]
• hereya workspace env set
• hereya workspace env unset
• hereya workspace executor install
• hereya workspace executor token
• hereya workspace executor uninstall
• hereya workspace install PACKAGE
• hereya workspace list
• hereya workspace set-profile PROFILE
• hereya workspace uninstall PACKAGE

hereya add PACKAGE

Add a package to the project.

USAGE
  $ hereya add PACKAGE [--chdir <value>] [--debug] [-p <value>...] [-w <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.
  -w, --workspace=<value>     name of the workspace to add the package to (defaults to current workspace)
      --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 clone PROJECT

Clone an existing template-based project to the local machine.

USAGE
  $ hereya clone PROJECT [--chdir <value>]

ARGUMENTS
  PROJECT  project name

FLAGS
  --chdir=<value>  directory to clone into

DESCRIPTION
  Clone an existing template-based project to the local machine.

EXAMPLES
  $ hereya clone myProject

  $ hereya clone myProject --chdir=./myProject

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

hereya config export-backend [FILE]

Export the cloud backend configuration to a file

USAGE
  $ hereya config export-backend [FILE]

ARGUMENTS
  FILE  Path to save the export file. Defaults to cloud-backend.json in current directory

DESCRIPTION
  Export the cloud backend configuration to a file

EXAMPLES
  $ hereya config export-backend

  $ hereya config export-backend ./path/to/export.json

See code: src/commands/config/export-backend/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 import-backend FILE

Import a backend configuration from a file

USAGE
  $ hereya config import-backend FILE

ARGUMENTS
  FILE  Path to the file containing the backend configuration to import

DESCRIPTION
  Import a backend configuration from a file

EXAMPLES
  $ hereya config import-backend ./path/to/cloud-backend.json

See code: src/commands/config/import-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 delete-state

Delete the remote state of a project for a given workspace

USAGE
  $ hereya delete-state -w <value> [--chdir <value>]

FLAGS
  -w, --workspace=<value>  (required) workspace name
      --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.

DESCRIPTION
  Delete the remote state of a project for a given workspace

EXAMPLES
  $ hereya delete-state -w dev

  $ hereya delete-state --workspace staging

See code: src/commands/delete-state/index.ts

hereya deploy

Deploy a hereya project using the project deployment package

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

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
      --local              force local execution (skip remote executor)

DESCRIPTION
  Deploy a hereya project using the project deployment package

EXAMPLES
  $ hereya deploy

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

hereya devenv config

Configure SSH for a dev environment and display connection details.

USAGE
  $ hereya devenv config -w <value>

FLAGS
  -w, --workspace=<value>  (required) name of the workspace to configure SSH for

DESCRIPTION
  Configure SSH for a dev environment and display connection details.

EXAMPLES
  $ hereya devenv config -w my-workspace

See code: src/commands/devenv/config/index.ts

hereya devenv install

Provision a remote dev environment on a workspace.

USAGE
  $ hereya devenv install -w <value> [--debug] [-p <value>...] [-f <value>] [-v <value>]

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.
  -v, --version=<value>         version of the dev environment package
  -w, --workspace=<value>       (required) name of the workspace to provision the dev environment on
      --debug                   enable debug mode

DESCRIPTION
  Provision a remote dev environment on a workspace.

EXAMPLES
  $ hereya devenv install -w my-workspace -p instanceType=t3.large

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

hereya devenv project init PROJECT

Initialize a project on a remote dev environment.

USAGE
  $ hereya devenv project init PROJECT -w <value> [-d <value>] [-f] [-p <value>...] [-t <value>]

ARGUMENTS
  PROJECT  project name

FLAGS
  -d, --deploy-workspace=<value>  workspace used for deployment (required when using a template)
  -f, --force                     continue even if folder already exists
  -p, --parameter=<value>...      [default: ] parameter for the template, in the form of 'key=value'. Can be specified
                                  multiple times.
  -t, --template=<value>          template package to scaffold the project from
  -w, --workspace=<value>         (required) name of the workspace

DESCRIPTION
  Initialize a project on a remote dev environment.

EXAMPLES
  $ hereya devenv project init my-app -w my-workspace

  $ hereya devenv project init my-app -w my-workspace -t acme/node-starter

  $ hereya devenv project init my-app -w my-workspace -t acme/node-starter -p region=us-east-1

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

hereya devenv project uninit PROJECT

Uninitialize a project on a remote dev environment.

USAGE
  $ hereya devenv project uninit PROJECT -w <value> [-f]

ARGUMENTS
  PROJECT  project name

FLAGS
  -f, --force              also remove the project directory after uninit
  -w, --workspace=<value>  (required) name of the workspace

DESCRIPTION
  Uninitialize a project on a remote dev environment.

EXAMPLES
  $ hereya devenv project uninit my-app -w my-workspace

  $ hereya devenv project uninit my-app -w my-workspace --force

See code: src/commands/devenv/project/uninit/index.ts

hereya devenv ssh

SSH into a dev environment instance.

USAGE
  $ hereya devenv ssh -w <value>

FLAGS
  -w, --workspace=<value>  (required) name of the workspace to SSH into

DESCRIPTION
  SSH into a dev environment instance.

EXAMPLES
  $ hereya devenv ssh -w my-workspace

See code: src/commands/devenv/ssh/index.ts

hereya devenv uninstall

Destroy and remove the dev environment from a workspace.

USAGE
  $ hereya devenv uninstall -w <value> [--debug]

FLAGS
  -w, --workspace=<value>  (required) name of the workspace to remove the dev environment from
      --debug              enable debug mode

DESCRIPTION
  Destroy and remove the dev environment from a workspace.

EXAMPLES
  $ hereya devenv uninstall -w my-workspace

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

hereya doc PACKAGE

Display documentation for a package from the registry

USAGE
  $ hereya doc PACKAGE [-C <value>] [-j] [--no-doc]

ARGUMENTS
  PACKAGE  Package name with optional version (e.g., my-package or [email protected])

FLAGS
  -j, --json    Output in JSON format
      --no-doc  Show only metadata without the full documentation

GLOBAL FLAGS
  -C, --chdir=<value>  [default: .] directory to run command in

DESCRIPTION
  Display documentation for a package from the registry

EXAMPLES
  $ hereya doc my-package

  $ hereya doc [email protected]

  $ hereya doc my-package --json

  $ hereya doc my-package --no-doc

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

hereya docker run IMAGE

Run a Docker container with hereya env vars injected as -e flags.

USAGE
  $ hereya docker run IMAGE... [--chdir <value>] [-p <value>] [-w <value>]

ARGUMENTS
  IMAGE...  Docker image to run

FLAGS
  -p, --port=<value>       [default: 8080] port to forward and set as PORT env var (default: 8080)
  -w, --workspace=<value>  name of the workspace to use
      --chdir=<value>      directory to run command in

DESCRIPTION
  Run a Docker container with hereya env vars injected as -e flags.

EXAMPLES
  $ hereya docker run myapp:latest

  $ hereya docker run -w staging myapp:latest

  $ hereya docker run -p 3000 myapp:latest

  $ hereya docker run myapp:latest -- --rm -v ./data:/data

See code: src/commands/docker/run/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 executor start

Start the remote executor process (polls for jobs from hereya cloud).

USAGE
  $ hereya executor start -w <value> [-c <value>]

FLAGS
  -c, --concurrency=<value>  [default: 10] maximum number of parallel jobs
  -w, --workspace=<value>    (required) name of the workspace to poll jobs for

DESCRIPTION
  Start the remote executor process (polls for jobs from hereya cloud).

  Jobs are executed in parallel up to the concurrency limit (default: 10). Use --concurrency to adjust.

  Set the HEREYA_TOKEN environment variable to authenticate without running `hereya login`.
  Set the HEREYA_CLOUD_URL environment variable to target a specific hereya cloud instance (defaults to
  https://cloud.hereya.dev).

EXAMPLES
  $ hereya executor start -w my-workspace

  $ hereya executor start -w my-workspace --concurrency 5

  HEREYA_TOKEN=<token> hereya executor start -w my-workspace

  HEREYA_TOKEN=<token> HEREYA_CLOUD_URL=https://my-cloud.example.com hereya executor start -w my-workspace

See code: src/commands/executor/start/index.ts

hereya flow add PACKAGE

Add a package to the project in a git branch-based workspace

USAGE
  $ hereya flow add PACKAGE [--chdir <value>] [--debug] [-p <value>...] [--profile <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
      --profile=<value>       profile to use for the workspace (will be appended to workspace name)

DESCRIPTION
  Add a package to the project in a git branch-based workspace

EXAMPLES
  $ hereya flow add cloudy/docker_postgres

  $ hereya flow add cloudy/docker_postgres --profile staging

  $ hereya flow add cloudy/docker_postgres -p DB_NAME=mydb -p DB_USER=admin

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

hereya flow docker run IMAGE

Run a Docker container with hereya env vars in a git branch-based workspace

USAGE
  $ hereya flow docker run IMAGE... [--chdir <value>] [--pin] [-p <value>] [--profile <value>]

ARGUMENTS
  IMAGE...  Docker image to run

FLAGS
  -p, --port=<value>     [default: 8080] port to forward and set as PORT env var (default: 8080)
      --chdir=<value>    directory to run command in
      --pin              append git commit SHA to workspace name for commit-specific isolation
      --profile=<value>  profile to use for the workspace (will be appended to workspace name)

DESCRIPTION
  Run a Docker container with hereya env vars in a git branch-based workspace

EXAMPLES
  $ hereya flow docker run myapp:latest

  $ hereya flow docker run --profile staging myapp:latest

  $ hereya flow docker run --pin myapp:latest -- --rm

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

hereya flow down

Create a git branch-based workspace and destroy all packages

USAGE
  $ hereya flow down [--chdir <value>] [--debug] [--deploy] [--pin] [--profile <value>] [-s <value>...]

FLAGS
  -s, --select=<value>...  [default: ] select the packages to destroy
      --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
      --pin                append git commit SHA to workspace name for commit-specific isolation
      --profile=<value>    profile to use for the workspace (will be appended to workspace name)

DESCRIPTION
  Create a git branch-based workspace and destroy all packages

EXAMPLES
  $ hereya flow down

  $ hereya flow down --debug

  $ hereya flow down --profile staging

  $ hereya flow down --pin

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

hereya flow env [NAME]

Print project environment variables for a git branch-based workspace

USAGE
  $ hereya flow env [NAME] [--chdir <value>] [-l] [--pin] [--profile <value>]

ARGUMENTS
  NAME  name of the env to display

FLAGS
  -l, --list             list only the env vars without values
      --chdir=<value>    project root directory
      --pin              append git commit SHA to workspace name for commit-specific isolation
      --profile=<value>  profile to use for the workspace (will be appended to workspace name)

DESCRIPTION
  Print project environment variables for a git branch-based workspace

EXAMPLES
  $ hereya flow env

  $ hereya flow env myEnv

  $ hereya flow env --profile staging

  $ hereya flow env --pin

  $ hereya flow env -l

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

hereya flow provid PACKAGE

Display the provisioning ID for a package in a git branch-based workspace

USAGE
  $ hereya flow provid PACKAGE [-C <value>] [--pin] [--profile <value>]

ARGUMENTS
  PACKAGE  Package name (e.g., hereya/postgres)

FLAGS
  -C, --chdir=<value>    Project root directory
      --pin              Append git commit SHA to workspace name for commit-specific isolation
      --profile=<value>  Profile to use for the workspace (will be appended to workspace name)

DESCRIPTION
  Display the provisioning ID for a package in a git branch-based workspace

EXAMPLES
  $ hereya flow provid hereya/postgres

  $ hereya flow provid hereya/postgres --profile staging

  $ hereya flow provid hereya/postgres --pin

See code: src/commands/flow/provid/index.ts

hereya flow remove PACKAGE

Remove a package from the project in a git branch-based workspace

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

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
  --profile=<value>  profile to use for the workspace (will be appended to workspace name)

DESCRIPTION
  Remove a package from the project in a git branch-based workspace

EXAMPLES
  $ hereya flow remove cloudy/docker_postgres

  $ hereya flow remove cloudy/docker_postgres --profile staging

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

hereya flow run CMD

Run a command with hereya env vars in a git branch-based workspace

USAGE
  $ hereya flow run CMD... [--chdir <value>] [--pin] [--profile <value>]

ARGUMENTS
  CMD...  command to run

FLAGS
  --chdir=<value>    directory to run command in
  --pin              append git commit SHA to workspace name for commit-specific isolation
  --profile=<value>  profile to use for the workspace (will be appended to workspace name)

DESCRIPTION
  Run a command with hereya env vars in a git branch-based workspace

EXAMPLES
  $ hereya flow run -- npm run dev

  $ hereya flow run --profile staging -- node index.js

  $ hereya flow run --pin -- npm test

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

hereya flow up

Create a git branch-based workspace and provision all packages

USAGE
  $ hereya flow up [--chdir <value>] [--debug] [--deploy] [--pin] [--profile <value>] [-s <value>...]

FLAGS
  -s, --select=<value>...  [default: ] select the packages to provision
      --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
      --pin                append git commit SHA to workspace name for commit-specific isolation
      --profile=<value>    profile to use for the workspace (will be appended to workspace name)

DESCRIPTION
  Create a git branch-based workspace and provision all packages

EXAMPLES
  $ hereya flow up

  $ hereya flow up --debug

  $ hereya flow up --profile staging

  $ hereya flow up --pin

See code: src/commands/flow/up/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 import PACKAGE

Import a package resource into your project

USAGE
  $ hereya import PACKAGE -f <value> [--chdir <value>] [--debug] [-p <value>...] [-w <value>]

ARGUMENTS
  PACKAGE  The package to import, 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
  -f, --stateFile=<value>     (required) state file to use
  -p, --parameter=<value>...  [default: ] parameters for the package, in the form of 'key=value'. Can be specified
                              multiple times.
  -w, --workspace=<value>     workspace to import into
      --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
  Import a package resource into your project

EXAMPLES
  $ hereya import hereya/my-package -f state.tfstate

  $ hereya import org/my-package -f state.tfstate -w my-workspace

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

hereya init PROJECT

Initialize hereya in a project directory.

USAGE
  $ hereya init PROJECT -w <value> [--chdir <value>] [-d <value>] [-p <value>...] [-t <value>]

ARGUMENTS
  PROJECT  project name

FLAGS
  -d, --deploy-workspace=<value>  workspace used for deployment (required when using a template)
  -p, --parameter=<value>...      [default: ] template parameter, in the form of 'key=value'. Can be specified multiple
                                  times.
  -t, --template=<value>          template package name (e.g. owner/repo)
  -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

  $ hereya init myProject -w=dev -t=acme/node-starter -d=prod

  $ hereya init myProject -w=dev -t=acme/node-starter -d=prod -p region=us-east-1

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

hereya list

List your projects.

USAGE
  $ hereya list

DESCRIPTION
  List your projects.

EXAMPLES
  $ hereya list

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

hereya login [URL]

Login to Hereya Cloud

USAGE
  $ hereya login [URL] [-t <value>]

ARGUMENTS
  URL  [default: https://cloud.hereya.dev] URL of the Hereya Cloud instance

FLAGS
  -t, --token=<value>  Token to use for login

DESCRIPTION
  Login to Hereya Cloud

EXAMPLES
  $ hereya login

  $ hereya login https://cloud.hereya.dev

  $ hereya login --token=your-token

  $ hereya login --token=your-token https://cloud.hereya.dev

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

hereya logout

Logout from Hereya Cloud

USAGE
  $ hereya logout

DESCRIPTION
  Logout from Hereya Cloud

EXAMPLES
  $ hereya logout

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

hereya provid PACKAGE

Display the provisioning ID for a package

USAGE
  $ hereya provid PACKAGE [-C <value>] [-w <value>]

ARGUMENTS
  PACKAGE  Package name (e.g., hereya/postgres)

FLAGS
  -C, --chdir=<value>      Project root directory
  -w, --workspace=<value>  Name of the workspace

DESCRIPTION
  Display the provisioning ID for a package

EXAMPLES
  $ hereya provid hereya/postgres

  $ hereya provid hereya/postgres -w dev

  $ hereya provid hereya/postgres --workspace staging

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

hereya publish

Publish a package to the Hereya registry

USAGE
  $ hereya publish [--chdir <value>]

FLAGS
  --chdir=<value>  Directory where the command will be executed.
                   If not specified, it defaults to the current working directory.

DESCRIPTION
  Publish a package to the Hereya registry

EXAMPLES
  $ hereya publish

  $ hereya publish --chdir=/path/to/package

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

hereya remove PACKAGE

Remove a package from the project.

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

ARGUMENTS
  PACKAGE  Remove a previously added package.

FLAGS
  -w, --workspace=<value>  name of the workspace to remove the package from (defaults to current workspace)
      --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 search QUERY

Search for packages in the registry

USAGE
  $ hereya search QUERY [-C <value>] [-j] [-l <value>]

ARGUMENTS
  QUERY  Search query string

FLAGS
  -j, --json           Output in JSON format
  -l, --limit=<value>  [default: 20] Maximum number of results to return

GLOBAL FLAGS
  -C, --chdir=<value>  [default: .] directory to run command in

DESCRIPTION
  Search for packages in the registry

EXAMPLES
  $ hereya search postgres

  $ hereya search redis --limit 5

  $ hereya search database --json

See code: src/commands/search/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] [--local]

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
      --local              force local execution (skip remote executor)

DESCRIPTION
  Undeploy a hereya project by removing all resources.

EXAMPLES
  $ hereya undeploy

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

hereya uninit PROJECT

Destroy template infrastructure and uninitialize a project.

USAGE
  $ hereya uninit PROJECT -w <value> [--chdir <value>] [-p <value>...]

ARGUMENTS
  PROJECT  project name

FLAGS
  -p, --parameter=<value>...  [default: ] parameter for the template, in the form of 'key=value'. Overrides saved
                              parameters.
  -w, --workspace=<value>     (required) workspace used during init
      --chdir=<value>         directory to run command in

DESCRIPTION
  Destroy template infrastructure and uninitialize a project.

EXAMPLES
  $ hereya uninit myProject -w dev

  $ hereya uninit myProject -w dev -p prodWorkspace=prod

See code: src/commands/uninit/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 update [VERSION]

Update hereya CLI to the latest or a specific version.

USAGE
  $ hereya update [VERSION]

ARGUMENTS
  VERSION  [default: latest] version to update to

DESCRIPTION
  Update hereya CLI to the latest or a specific version.

EXAMPLES
  $ hereya update

  $ hereya update 0.75.0

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

hereya workspace create NAME

Create a new workspace if it does not exist.

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

ARGUMENTS
  NAME  name of the workspace to create

FLAGS
  -d, --deployment       mark workspace as a deployment workspace
      --mirror=<value>   workspace to mirror
      --profile=<value>  workspace profile to set (cloud backend only)

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 executor install

Install a remote executor into a workspace

USAGE
  $ hereya workspace executor install -w <value> [--debug] [-f]

FLAGS
  -f, --force              force reinstall even if executor is already installed
  -w, --workspace=<value>  (required) name of the workspace
      --debug              enable debug mode

DESCRIPTION
  Install a remote executor into a workspace

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

hereya workspace executor token

Generate a workspace-scoped executor token for the remote executor

USAGE
  $ hereya workspace executor token -w <value>

FLAGS
  -w, --workspace=<value>  (required) name of the workspace

DESCRIPTION
  Generate a workspace-scoped executor token for the remote executor

See code: src/commands/workspace/executor/token/index.ts

hereya workspace executor uninstall

Uninstall the remote executor from a workspace

USAGE
  $ hereya workspace executor uninstall -w <value> [--debug]

FLAGS
  -w, --workspace=<value>  (required) name of the workspace
      --debug              enable debug mode

DESCRIPTION
  Uninstall the remote executor from a workspace

See code: src/commands/workspace/executor/uninstall/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 [-o <value>]

FLAGS
  -o, --org=<value>  Filter workspaces by organization name. Use "personal" to show only your personal workspaces.

DESCRIPTION
  List workspaces.

EXAMPLES
  $ hereya workspace list

  $ hereya workspace list --org my-org

  $ hereya workspace list --org personal

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

hereya workspace set-profile PROFILE

Set AWS profile and deployment status for a workspace (cloud backend only).

USAGE
  $ hereya workspace set-profile PROFILE -w <value> [-d]

ARGUMENTS
  PROFILE  AWS profile name to set for the workspace

FLAGS
  -d, --[no-]deployment    mark workspace as a deployment workspace (use --no-deployment to unset)
  -w, --workspace=<value>  (required) workspace name

DESCRIPTION
  Set AWS profile and deployment status for a workspace (cloud backend only).

EXAMPLES
  $ hereya workspace set-profile prod-profile -w production

See code: src/commands/workspace/set-profile/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