@hyperdrive.bot/cli

v1.0.6

Published

7 days ago

hyperdrive.bot is a command-line interface (CLI) tool designed for managing and deploying projects using the Hyperdrive API. The CLI acts as a proxy to the Hyperdrive API, enabling users to:

0High
0Medium
0Low

marcelodevsquad

oclif

hd

hyperdrive.bot is a command-line interface (CLI) tool designed for managing and deploying projects using the Hyperdrive API. The CLI acts as a proxy to the Hyperdrive API, enabling users to:

Usage

$ npm install -g @hyperdrive.bot/cli
$ hd COMMAND
running command...
$ hd (--version)
@hyperdrive.bot/cli/1.0.6 linux-x64 node-v18.20.8
$ hd --help [COMMAND]
USAGE
  $ hd COMMAND
...

Commands

`hd account add`

Add an AWS account to Hyperdrive for deployments

USAGE
  $ hd account add [-a <value>] [-r <value>] [-d <value>] [-n <value>] [--no-wait] [--roleArn <value>]

FLAGS
  -a, --accountId=<value>      AWS Account ID (12 digits)
  -d, --domain=<value>         Tenant domain (for multi-domain setups)
  -n, --name=<value>           Friendly name for the account
  -r, --defaultRegion=<value>  Default AWS region for deployments
      --no-wait                Do not wait for role verification after opening CloudFormation
      --roleArn=<value>        Cross-account IAM role ARN (optional - will be auto-generated if not provided)

DESCRIPTION
  Add an AWS account to Hyperdrive for deployments

EXAMPLES
  $ hd account add --accountId 123456789012 --defaultRegion us-east-1

  $ hd account add --accountId 123456789012 --defaultRegion us-east-1 --name "Production Account"

  $ hd account add # Interactive mode

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

`hd account list`

List all AWS accounts registered with Hyperdrive

USAGE
  $ hd account list

DESCRIPTION
  List all AWS accounts registered with Hyperdrive

EXAMPLES
  $ hd account list

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

`hd account remove`

Remove an AWS account from Hyperdrive

USAGE
  $ hd account remove -a <value> [-d <value>] [-f]

FLAGS
  -a, --accountId=<value>  (required) AWS Account ID (12 digits)
  -d, --domain=<value>     Tenant domain (for multi-domain setups)
  -f, --force              Skip confirmation prompt

DESCRIPTION
  Remove an AWS account from Hyperdrive

EXAMPLES
  $ hd account remove --accountId 123456789012

  $ hd account remove --accountId 123456789012 --force

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

`hd auth login`

Authenticate with Hyperdrive using OAuth 2.0 PKCE flow (or CI credentials)

USAGE
  $ hd auth login [--ci] [-d <value>] [-p <value>]

FLAGS
  -d, --domain=<value>  Tenant domain (e.g., acme.hyperdrive.bot) - allows multiple installations
  -p, --port=<value>    [default: 8765] Local callback server port
      --ci              Use CI authentication (requires HD_CI_USERNAME and HD_CI_PASSWORD env vars)

DESCRIPTION
  Authenticate with Hyperdrive using OAuth 2.0 PKCE flow (or CI credentials)

EXAMPLES
  $ hd auth login

  $ hd auth login --domain acme.hyperdrive.bot

  $ hd auth login --port 9876

  $ hd auth login --ci --domain acme.hyperdrive.bot

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

`hd auth logout`

Remove stored credentials and logout

USAGE
  $ hd auth logout

DESCRIPTION
  Remove stored credentials and logout

EXAMPLES
  $ hd auth logout

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

`hd auth refresh`

Refresh expired AWS credentials using refresh token

USAGE
  $ hd auth refresh

DESCRIPTION
  Refresh expired AWS credentials using refresh token

EXAMPLES
  $ hd auth refresh

See code: src/commands/auth/refresh.ts

`hd auth status`

Show current authentication status

USAGE
  $ hd auth status

DESCRIPTION
  Show current authentication status

EXAMPLES
  $ hd auth status

See code: src/commands/auth/status.ts

`hd ci account create`

Create a CI token for non-interactive authentication in CI/CD pipelines

USAGE
  $ hd ci account create [--description <value>] [-d <value>] [-n <value>] [--project <value>] [-s
    deploy|deploy:create|deploy:launch|module:read|module:write|parameter:read|parameter:write|stage:read|stage:write]
    [--stage <value>]

FLAGS
  -d, --domain=<value>       Tenant domain
  -n, --name=<value>         Name for the CI account (e.g., github-prod, gitlab-staging)
  -s, --scope=<option>...    Scopes to grant (can be specified multiple times)
                             <options: deploy|deploy:create|deploy:launch|module:read|module:write|parameter:read|parame
                             ter:write|stage:read|stage:write>
      --description=<value>  Optional description for the CI account
      --project=<value>...   Restrict to specific project slugs (can be specified multiple times)
      --stage=<value>...     Restrict to specific stages (can be specified multiple times)

DESCRIPTION
  Create a CI token for non-interactive authentication in CI/CD pipelines

EXAMPLES
  $ hd ci account create --name="github-prod" --scope=deploy --scope=module:read

  $ hd ci account create --name="gitlab-staging" --scope=deploy --scope=parameter:read

See code: src/commands/ci/account/create.ts

`hd ci account delete [ACCOUNTID]`

Delete (revoke) a CI token

USAGE
  $ hd ci account delete [ACCOUNTID] [-d <value>] [-f]

ARGUMENTS
  ACCOUNTID  CI token ID to delete

FLAGS
  -d, --domain=<value>  Tenant domain
  -f, --force           Skip confirmation prompt

DESCRIPTION
  Delete (revoke) a CI token

EXAMPLES
  $ hd ci account delete <account-id>

  $ hd ci account delete <account-id> --force

See code: src/commands/ci/account/delete.ts

`hd ci account list`

List all CI tokens

USAGE
  $ hd ci account list [-d <value>] [--json]

FLAGS
  -d, --domain=<value>  Tenant domain
      --json            Output as JSON

DESCRIPTION
  List all CI tokens

EXAMPLES
  $ hd ci account list

  $ hd ci account list --json

See code: src/commands/ci/account/list.ts

`hd config get KEY`

Get CLI configuration value

USAGE
  $ hd config get KEY

ARGUMENTS
  KEY  (tenant-domain|bootstrap-url|api-url|region) Configuration key

DESCRIPTION
  Get CLI configuration value

EXAMPLES
  $ hd config get tenant-domain

  $ hd config get bootstrap-url

See code: src/commands/config/get.ts

`hd config set KEY VALUE`

Set CLI configuration values

USAGE
  $ hd config set KEY VALUE

ARGUMENTS
  KEY    (tenant-domain|bootstrap-url|api-url|region) Configuration key
  VALUE  Configuration value

DESCRIPTION
  Set CLI configuration values

EXAMPLES
  $ hd config set tenant-domain acme.hyperdrive.bot

  $ hd config set bootstrap-url https://custom-api.example.com/tenant/bootstrap

  $ hd config set api-url https://api.us-east-1.hyperdrive.bot

  $ hd config set region us-west-2

See code: src/commands/config/set.ts

`hd config show`

Show all CLI configuration settings

USAGE
  $ hd config show

DESCRIPTION
  Show all CLI configuration settings

EXAMPLES
  $ hd config show

See code: src/commands/config/show.ts

`hd deployment create`

Create a new deployment with real-time log streaming

USAGE
  $ hd deployment create -c <value> -m <value> -s <value> [--debug] [-d <value>] [--launch] [-n <value>] [--noStream]
    [-r <value>] [-v]

FLAGS
  -c, --commit=<value>      (required) Commit hash
  -d, --domain=<value>      Tenant domain (for multi-domain setups)
  -m, --moduleSlug=<value>  (required) Module slug
  -n, --name=<value>        [default: Deployment-2026-01-18-20-49-13] The name of the deployment
  -r, --regions=<value>...  [default: ] Regions for the deployment
  -s, --stage=<value>       (required) Stage for the deployment
  -v, --verbose             Show detailed build logs
      --debug               Include debug-level logs (requires --verbose)
      --launch              Launch the deployment after creating it
      --noStream            Disable log streaming (use polling instead)

DESCRIPTION
  Create a new deployment with real-time log streaming

EXAMPLES
  $ hd deployment create --stage="dev" --commit="abc123" --moduleSlug="my-api"

  $ hd deployment create --stage="dev" --commit="abc123" --launch

  $ hd deployment create --stage="dev" --commit="abc123" --verbose

See code: src/commands/deployment/create.ts

`hd deployment get`

Get details of a specific deployment (alias for deployment check)

USAGE
  $ hd deployment get -m <value> -n <value> -s <value> [-d <value>]

FLAGS
  -d, --domain=<value>      Tenant domain (for multi-domain setups)
  -m, --moduleSlug=<value>  (required) Module slug
  -n, --name=<value>        (required) Deployment name
  -s, --stage=<value>       (required) Stage for the deployment

DESCRIPTION
  Get details of a specific deployment (alias for deployment check)

EXAMPLES
  $ hd deployment get --name="Deployment-2024-01-01" --stage="dev"

  $ hd deployment get --name="prod-release-v1" --stage="prod"

See code: src/commands/deployment/get.ts

`hd deployment launch`

Launch an existing deployment

USAGE
  $ hd deployment launch -m <value> -n <value> -s <value> [-d <value>] [-f] [-r <value>]

FLAGS
  -d, --domain=<value>      Tenant domain (for multi-domain setups)
  -f, --force               Force launch even if deployment is not in ready state
  -m, --moduleSlug=<value>  (required) Module slug
  -n, --name=<value>        (required) The name of the deployment to launch
  -r, --region=<value>      Region for the deployment
  -s, --stage=<value>       (required) Stage for the deployment

DESCRIPTION
  Launch an existing deployment

EXAMPLES
  $ hd deployment launch --name="Deployment-2024-01-01" --stage="dev" --region="us-east-1"

  $ hd deployment launch --name="prod-release" --stage="prod" --region="us-west-2"

See code: src/commands/deployment/launch.ts

`hd deployment list`

List all deployments for a module and stage

USAGE
  $ hd deployment list -m <value> -s <value> [-d <value>]

FLAGS
  -d, --domain=<value>      Tenant domain (for multi-domain setups)
  -m, --moduleSlug=<value>  (required) Module slug
  -s, --stage=<value>       (required) Stage to list deployments for

DESCRIPTION
  List all deployments for a module and stage

EXAMPLES
  $ hd deployment list --stage="dev"

  $ hd deployment list --stage="prod" --moduleSlug="my-api"

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

`hd domain current`

Show the current default domain

USAGE
  $ hd domain current

DESCRIPTION
  Show the current default domain

EXAMPLES
  $ hd domain current

See code: src/commands/domain/current.ts

`hd domain list`

List all configured domains/installations

USAGE
  $ hd domain list

DESCRIPTION
  List all configured domains/installations

EXAMPLES
  $ hd domain list

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

`hd domain switch DOMAIN`

Switch the default domain for CLI commands

USAGE
  $ hd domain switch DOMAIN

ARGUMENTS
  DOMAIN  The domain to set as default

DESCRIPTION
  Switch the default domain for CLI commands

EXAMPLES
  $ hd domain switch acme.hyperdrive.bot

See code: src/commands/domain/switch.ts

`hd example [FILE]`

describe the command here

USAGE
  $ hd example [FILE] [-f] [-n <value>]

ARGUMENTS
  FILE  file to read

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

DESCRIPTION
  describe the command here

EXAMPLES
  $ hd example

See code: src/commands/example.ts

`hd git connect`

Connect a GitHub or GitLab account to Hyperdrive

USAGE
  $ hd git connect [-d <value>] [-p github|gitlab]

FLAGS
  -d, --domain=<value>     Tenant domain (for multi-domain setups)
  -p, --provider=<option>  Git provider to connect
                           <options: github|gitlab>

DESCRIPTION
  Connect a GitHub or GitLab account to Hyperdrive

EXAMPLES
  $ hd git connect --provider=github

  $ hd git connect --provider=gitlab

See code: src/commands/git/connect.ts

`hd git disconnect`

Disconnect a Git account from Hyperdrive

USAGE
  $ hd git disconnect [-d <value>] [-i <value>] [-p github|gitlab]

FLAGS
  -d, --domain=<value>          Tenant domain (for multi-domain setups)
  -i, --installationId=<value>  Installation ID to disconnect
  -p, --provider=<option>       Git provider
                                <options: github|gitlab>

DESCRIPTION
  Disconnect a Git account from Hyperdrive

EXAMPLES
  $ hd git disconnect

  $ hd git disconnect --provider=github --installation-id=12345

See code: src/commands/git/disconnect.ts

`hd git list`

List connected Git accounts

USAGE
  $ hd git list [-d <value>] [-p github|gitlab]

FLAGS
  -d, --domain=<value>     Tenant domain (for multi-domain setups)
  -p, --provider=<option>  Filter by Git provider
                           <options: github|gitlab>

DESCRIPTION
  List connected Git accounts

EXAMPLES
  $ hd git list

  $ hd git list --provider=github

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

`hd git sync`

Sync specific branches or all open branches with a source branch (default: master)

USAGE
  $ hd git sync [-a] [-b <value>] [-d <value>] [-m no-ff|--ff-only|--no-ff|--squash] [-r <value>] [-s <value>]
    [-v]

FLAGS
  -a, --all                      Sync all remote branches
  -b, --branch=<value>...        Specific branch(es) to sync (can be used multiple times)
  -d, --domain=<value>           Tenant domain (for multi-domain setups)
  -m, --merge-strategy=<option>  [default: no-ff] Git merge strategy
                                 <options: no-ff|--ff-only|--no-ff|--squash>
  -r, --remote=<value>           [default: origin] Remote repository name
  -s, --source-branch=<value>    [default: master] Source branch to merge from
  -v, --verbose                  Show detailed progress information

DESCRIPTION
  Sync specific branches or all open branches with a source branch (default: master)

EXAMPLES
  $ hd git sync --branch feature-branch

  $ hd git sync --branch feature-1 --branch feature-2

  $ hd git sync --all

  $ hd git sync --branch feature-branch --source-branch main

  $ hd git sync --all --remote upstream --merge-strategy no-ff

See code: src/commands/git/sync.ts

`hd help [COMMAND]`

Display help for hd.

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

See code: @oclif/plugin-help

`hd init`

Initialize Hyperdrive CLI with guided setup wizard

USAGE
  $ hd init

DESCRIPTION
  Initialize Hyperdrive CLI with guided setup wizard

EXAMPLES
  $ hd init

See code: src/commands/init.ts

`hd jira connect`

USAGE
  $ hd jira connect [-d <value>]

FLAGS
  -d, --domain=<value>  Your Jira domain (e.g., dev-squad.atlassian.net)

DESCRIPTION
  Register your Jira instance with Hyperdrive (run BEFORE installing the Forge app)

EXAMPLES
  $ hd jira connect

  $ hd jira connect --domain dev-squad.atlassian.net

See code: src/commands/jira/connect.ts

`hd jira status`

Check the status of your Jira integration

USAGE
  $ hd jira status [-d <value>]

FLAGS
  -d, --domain=<value>  Tenant domain (for multi-domain setups)

DESCRIPTION
  Check the status of your Jira integration

EXAMPLES
  $ hd jira status

See code: src/commands/jira/status.ts

`hd module analyze`

Analyze a module and generate an optimized Dockerfile using AI

USAGE
  $ hd module analyze -s <value> [-d <value>] [--save] [-v] [-w]

FLAGS
  -d, --domain=<value>  Tenant domain (for multi-domain setups)
  -s, --slug=<value>    (required) Module slug to analyze
  -v, --verbose         Show detailed analysis progress and real-time logs
  -w, --wait            Wait for analysis to complete and show results
      --save            Save generated Dockerfile to current directory

DESCRIPTION
  Analyze a module and generate an optimized Dockerfile using AI

EXAMPLES
  $ hd module analyze --slug="my-module"

  $ hd module analyze

  $ hd module analyze --slug="my-module" --verbose

See code: src/commands/module/analyze.ts

`hd module create`

Create a new project

USAGE
  $ hd module create [--buildCommand <value>] [--buildDirectory <value>] [--buildFolder <value>] [--buildRuntime
    nodejs|python|go|rust|java|dotnet|ruby] [--buildRuntimeVersion <value>] [--ciService
    github-actions|gitlab-ci|circle-ci|jenkins] [--defaultBranch <value>] [-d <value>] [--framework
    express|fastify|koa|nextjs|react|vue|angular|svelte|flask|django|fastapi|gin|actix|spring|aspnet|rails|other]
    [--installCommand <value>] [--name <value>] [--runCommand <value>] [-r nodejs|python|go|rust|java|dotnet|ruby]
    [--runtimeVersion <value>] [--slug <value>] [--sourceDirectory <value>] [--sourceLocation <value>]

FLAGS
  -d, --domain=<value>               Tenant domain (for multi-domain setups)
  -r, --runtime=<option>             Runtime environment
                                     <options: nodejs|python|go|rust|java|dotnet|ruby>
      --buildCommand=<value>         Build command
      --buildDirectory=<value>       Build output directory (e.g., dist, build, .next) - where compiled artifacts are
                                     output
      --buildFolder=<value>          Build folder
      --buildRuntime=<option>        Build runtime for Dockerfile template selection
                                     <options: nodejs|python|go|rust|java|dotnet|ruby>
      --buildRuntimeVersion=<value>  Build runtime version (e.g., 20 for Node, 3.12 for Python)
      --ciService=<option>           CI service used
                                     <options: github-actions|gitlab-ci|circle-ci|jenkins>
      --defaultBranch=<value>        Default git branch to branch from (e.g., main, master)
      --framework=<option>           Framework used
                                     <options: express|fastify|koa|nextjs|react|vue|angular|svelte|flask|django|fastapi|
                                     gin|actix|spring|aspnet|rails|other>
      --installCommand=<value>       Install command
      --name=<value>                 Name of the project
      --runCommand=<value>           Run command
      --runtimeVersion=<value>       Runtime version (e.g., 20, 3.12, 1.21)
      --slug=<value>                 Slug of the project
      --sourceDirectory=<value>      Source code directory (e.g., src, lib, . for root) - default: src for Lambda, . for
                                     static
      --sourceLocation=<value>       Source location of the project

DESCRIPTION
  Create a new project

EXAMPLES
  $ hd module create --name="New Project" --slug="project-slug"

  $ hd module create --name="API Service" --framework="Serverless Framework"

See code: src/commands/module/create.ts

`hd module destroy`

Destroy/delete a module permanently

USAGE
  $ hd module destroy -s <value> [-d <value>] [-f]

FLAGS
  -d, --domain=<value>  Tenant domain (for multi-domain setups)
  -f, --force           Skip confirmation prompt (DANGEROUS)
  -s, --slug=<value>    (required) Module slug to destroy

DESCRIPTION
  Destroy/delete a module permanently

EXAMPLES
  $ hd module destroy --slug="my-module"

  $ hd module destroy --slug="old-project" --force

See code: src/commands/module/destroy.ts

`hd module get`

Get details of a specific module/project

USAGE
  $ hd module get -s <value> [-d <value>]

FLAGS
  -d, --domain=<value>  Tenant domain (for multi-domain setups)
  -s, --slug=<value>    (required) Module slug to get details for

DESCRIPTION
  Get details of a specific module/project

EXAMPLES
  $ hd module get --slug="my-module"

  $ hd module get

See code: src/commands/module/get.ts

`hd module link`

Links two modules using specified environment variables as connectors

USAGE
  $ hd module link --originSlug <value> --parameter <value> --targetSlug <value> [-d <value>]

FLAGS
  -d, --domain=<value>        Tenant domain (for multi-domain setups)
      --originSlug=<value>    (required) Slug of the origin module (the one that depends on another)
      --parameter=<value>...  (required) Environment variable to link (e.g., API_URL)
      --targetSlug=<value>    (required) Slug of the target module (the dependency)

DESCRIPTION
  Links two modules using specified environment variables as connectors

EXAMPLES
  $ hd module link --originSlug="vixting-integration" --targetSlug="vixting-api" --parameter="VLOW_API_ENDPOINT_PREFIX"

See code: src/commands/module/link.ts

`hd module list`

List all modules/projects

USAGE
  $ hd module list [-d <value>]

FLAGS
  -d, --domain=<value>  Tenant domain (for multi-domain setups)

DESCRIPTION
  List all modules/projects

EXAMPLES
  $ hd module list

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

`hd module reanalyze`

Reanalyze a module's Dockerfile with custom instructions

USAGE
  $ hd module reanalyze -p <value> -s <value> [-d <value>] [--save] [-v] [-w]

FLAGS
  -d, --domain=<value>  Tenant domain (for multi-domain setups)
  -p, --prompt=<value>  (required) Custom instructions for Dockerfile regeneration
  -s, --slug=<value>    (required) Module slug to reanalyze
  -v, --verbose         Show detailed analysis progress and real-time logs
  -w, --wait            Wait for reanalysis to complete and show results
      --save            Save generated Dockerfile to current directory

DESCRIPTION
  Reanalyze a module's Dockerfile with custom instructions

EXAMPLES
  $ hd module reanalyze --slug="my-module" --prompt="Use Node.js 18 instead of 20"

  $ hd module reanalyze --prompt="Fix the build - missing Python dependency"

  $ hd module reanalyze -s my-module -p "Exclude source maps from S3 upload" --verbose

See code: src/commands/module/reanalyze.ts

`hd module update`

Update a module/project configuration

USAGE
  $ hd module update -s <value> [--buildCommand <value>] [--buildDirectory <value>] [--buildFolder <value>]
    [--buildRuntime nodejs|python|go|rust|java|dotnet|ruby] [--buildRuntimeVersion <value>] [--ciService
    github-actions|gitlab-ci|circle-ci|jenkins] [--defaultBranch <value>] [--deploymentStrategy serverless] [-d <value>]
    [--framework
    express|fastify|koa|nextjs|react|vue|angular|svelte|flask|django|fastapi|gin|actix|spring|aspnet|rails|other]
    [--installCommand <value>] [--name <value>] [--routeDiscovery] [--runCommand <value>] [-r
    nodejs|python|go|rust|java|dotnet|ruby] [-v <value>] [--sourceDirectory <value>] [--sourceLocation <value>]

FLAGS
  -d, --domain=<value>               Tenant domain (for multi-domain setups)
  -r, --runtime=<option>             Runtime environment
                                     <options: nodejs|python|go|rust|java|dotnet|ruby>
  -s, --slug=<value>                 (required) Module slug to update (required)
  -v, --runtimeVersion=<value>       Runtime version (e.g., 20, 3.12, 1.21)
      --buildCommand=<value>         Build command
      --buildDirectory=<value>       Build output directory (e.g., dist, build, .next) - where compiled artifacts are
                                     output
      --buildFolder=<value>          Build folder
      --buildRuntime=<option>        Build runtime for Dockerfile template selection
                                     <options: nodejs|python|go|rust|java|dotnet|ruby>
      --buildRuntimeVersion=<value>  Build runtime version (e.g., 20 for Node, 3.12 for Python)
      --ciService=<option>           CI service used
                                     <options: github-actions|gitlab-ci|circle-ci|jenkins>
      --defaultBranch=<value>        Default git branch to branch from (e.g., main, master)
      --deploymentStrategy=<option>  Deployment strategy: "serverless" for Serverless Framework deployment to Lambda
                                     <options: serverless>
      --framework=<option>           Framework used
                                     <options: express|fastify|koa|nextjs|react|vue|angular|svelte|flask|django|fastapi|
                                     gin|actix|spring|aspnet|rails|other>
      --installCommand=<value>       Install command
      --name=<value>                 Name of the project
      --[no-]routeDiscovery          Enable AI-powered route discovery for per-route Lambda functions
      --runCommand=<value>           Run command
      --sourceDirectory=<value>      Source code directory (e.g., src, lib, . for root) - default: src for Lambda, . for
                                     static
      --sourceLocation=<value>       Source location of the project

DESCRIPTION
  Update a module/project configuration

EXAMPLES
  $ hd module update --slug="my-module" --runtimeVersion="12"

  $ hd module update --slug="my-module" --buildCommand="npm run build:prod"

  $ hd module update --slug="my-module" --name="New Name" --framework="React.js"

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

`hd parameter add`

Add a new parameter to SSM Parameter Store

USAGE
  $ hd parameter add --accountId <value> -k <value> -m <value> -v <value> [-d <value>] [--specific] [-s <value>]

FLAGS
  -d, --domain=<value>      Tenant domain (for multi-domain setups)
  -k, --key=<value>         (required) Parameter key/name
  -m, --moduleSlug=<value>  (required) Module slug
  -s, --stage=<value>       [default: all] Stage for the parameter (default: all stages)
  -v, --value=<value>       (required) Parameter value
      --accountId=<value>   (required) AWS Account ID
      --specific            Make parameter specific to this project (default: global)

DESCRIPTION
  Add a new parameter to SSM Parameter Store

EXAMPLES
  $ hd parameter add --key="API_URL" --value="https://api.example.com" --stage="dev"

  $ hd parameter add --key="DB_HOST" --value="localhost" --specific

  $ hd parameter add --key="PORT" --value="3000"

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

`hd parameter backfill`

Backfill existing SSM parameters to DynamoDB (one-time migration)

USAGE
  $ hd parameter backfill --accountId <value> [-d <value>] [--dry-run] [--no-dry-run]

FLAGS
  -d, --domain=<value>     Tenant domain (for multi-domain setups)
      --accountId=<value>  (required) AWS Account ID to backfill from
      --dry-run            Preview what would be imported without making changes (default: true)
      --no-dry-run         Actually perform the backfill (writes to DynamoDB)

DESCRIPTION
  Backfill existing SSM parameters to DynamoDB (one-time migration)

EXAMPLES
  $ hd parameter backfill --accountId="123456789012" --dry-run

  $ hd parameter backfill --accountId="123456789012"

See code: src/commands/parameter/backfill.ts

`hd parameter clear`

Clear all parameters for a project and stage (DANGEROUS)

USAGE
  $ hd parameter clear --accountId <value> -m <value> [-d <value>] [-f] [--specific] [-s <value>]

FLAGS
  -d, --domain=<value>      Tenant domain (for multi-domain setups)
  -f, --force               Skip confirmation prompt (DANGEROUS)
  -m, --moduleSlug=<value>  (required) Module slug
  -s, --stage=<value>       [default: all] Stage to clear parameters for
      --accountId=<value>   (required) AWS Account ID
      --specific            Clear only project-specific parameters (default: global)

DESCRIPTION
  Clear all parameters for a project and stage (DANGEROUS)

EXAMPLES
  $ hd parameter clear --stage="dev"

  $ hd parameter clear --stage="prod" --specific --force

See code: src/commands/parameter/clear.ts

`hd parameter list`

List all parameters for a project and stage

USAGE
  $ hd parameter list --accountId <value> -m <value> [--all-stages] [-d <value>] [--specific] [-s <value>]

FLAGS
  -d, --domain=<value>      Tenant domain (for multi-domain setups)
  -m, --moduleSlug=<value>  (required) Module slug
  -s, --stage=<value>       [default: all] Stage to list parameters for
      --accountId=<value>   (required) AWS Account ID
      --all-stages          List parameters from all stages
      --specific            List only project-specific parameters

DESCRIPTION
  List all parameters for a project and stage

EXAMPLES
  $ hd parameter list --stage="dev"

  $ hd parameter list --stage="prod" --specific

  $ hd parameter list --all-stages

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

`hd parameter pull`

Pull parameters from SSM Parameter Store to a .env file

USAGE
  $ hd parameter pull --accountId <value> -m <value> -s <value> [--backup] [-d <value>] [-f <value>]

FLAGS
  -d, --domain=<value>      Tenant domain (for multi-domain setups)
  -f, --file=<value>        [default: .env] Output file path
  -m, --moduleSlug=<value>  (required) Module slug
  -s, --stage=<value>       (required) Stage to pull parameters from
      --accountId=<value>   (required) AWS Account ID
      --[no-]backup         Create .env.backup before overwriting (default: true)

DESCRIPTION
  Pull parameters from SSM Parameter Store to a .env file

EXAMPLES
  $ hd parameter pull --stage="dev"

  $ hd parameter pull --stage="prod" --file=".env.prod"

  $ hd parameter pull --stage="dev" --no-backup

See code: src/commands/parameter/pull.ts

`hd parameter remove`

Remove a parameter from SSM Parameter Store

USAGE
  $ hd parameter remove --accountId <value> -k <value> -m <value> [-d <value>] [-f] [--specific] [-s <value>]

FLAGS
  -d, --domain=<value>      Tenant domain (for multi-domain setups)
  -f, --force               Skip confirmation prompt
  -k, --key=<value>         (required) Parameter key/name to remove
  -m, --moduleSlug=<value>  (required) Module slug
  -s, --stage=<value>       [default: all] Stage for the parameter (default: all stages)
      --accountId=<value>   (required) AWS Account ID
      --specific            Remove from project-specific parameters (default: global)

DESCRIPTION
  Remove a parameter from SSM Parameter Store

EXAMPLES
  $ hd parameter remove --key="API_URL" --stage="dev"

  $ hd parameter remove --key="DB_HOST" --specific --stage="prod"

  $ hd parameter remove --key="PORT" --force

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

`hd parameter sync`

Synchronize environment variables from a .env file to Hyperdrive

USAGE
  $ hd parameter sync --accountId <value> -m <value> [-d <value>] [-f <value>] [-s] [-t <value>]

FLAGS
  -d, --domain=<value>      Tenant domain (for multi-domain setups)
  -f, --file=<value>        [default: .env] Path to the .env file
  -m, --moduleSlug=<value>  (required) Module slug
  -s, --[no-]specific       Whether the env vars are project-specific (default: true)
  -t, --stage=<value>       [default: all] Stage for the env vars (default: all stages)
      --accountId=<value>   (required) AWS Account ID

DESCRIPTION
  Synchronize environment variables from a .env file to Hyperdrive

EXAMPLES
  $ hd parameter sync --stage="dev"

  $ hd parameter sync --file=".env.production" --stage="prod"

  $ hd parameter sync --no-specific --stage="all"

See code: src/commands/parameter/sync.ts

`hd parameter update`

Update an existing parameter in SSM Parameter Store

USAGE
  $ hd parameter update --accountId <value> -k <value> -m <value> -v <value> [-d <value>] [--specific] [-s <value>]

FLAGS
  -d, --domain=<value>      Tenant domain (for multi-domain setups)
  -k, --key=<value>         (required) Parameter key/name to update
  -m, --moduleSlug=<value>  (required) Module slug
  -s, --stage=<value>       [default: all] Stage for the parameter (default: all stages)
  -v, --value=<value>       (required) New parameter value
      --accountId=<value>   (required) AWS Account ID
      --specific            Update project-specific parameter (default: global)

DESCRIPTION
  Update an existing parameter in SSM Parameter Store

EXAMPLES
  $ hd parameter update --key="API_URL" --value="https://new-api.example.com" --stage="dev"

  $ hd parameter update --key="DB_HOST" --value="new-host" --specific

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

`hd plugins`

List installed plugins.

USAGE
  $ hd plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ hd plugins

See code: @oclif/plugin-plugins

`hd plugins add PLUGIN`

Installs a plugin into hd.

USAGE
  $ hd plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into hd.

  Uses bundled npm executable to install plugins into /root/.local/share/hd

  Installation of a user-installed plugin will override a core plugin.

  Use the HD_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the HD_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ hd plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ hd plugins add myplugin

  Install a plugin from a github url.

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

  Install a plugin from a github slug.

    $ hd plugins add someuser/someplugin

`hd plugins:inspect PLUGIN...`

Displays installation properties of a plugin.

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

See code: @oclif/plugin-plugins

`hd plugins install PLUGIN`

Installs a plugin into hd.

USAGE
  $ hd plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into hd.

  Uses bundled npm executable to install plugins into /root/.local/share/hd

  Installation of a user-installed plugin will override a core plugin.

  Use the HD_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the HD_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ hd plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ hd plugins install myplugin

  Install a plugin from a github url.

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

  Install a plugin from a github slug.

    $ hd plugins install someuser/someplugin

See code: @oclif/plugin-plugins

`hd plugins link PATH`

Links a plugin into the CLI for development.

USAGE
  $ hd plugins link PATH [-h] [--install] [-v]

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
  $ hd plugins link myplugin

See code: @oclif/plugin-plugins

`hd plugins remove [PLUGIN]`

Removes a plugin from the CLI.

USAGE
  $ hd plugins remove [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ hd plugins unlink
  $ hd plugins remove

EXAMPLES
  $ hd plugins remove myplugin

`hd plugins reset`

Remove all user-installed and linked plugins.

USAGE
  $ hd 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

`hd plugins uninstall [PLUGIN]`

Removes a plugin from the CLI.

USAGE
  $ hd plugins uninstall [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ hd plugins unlink
  $ hd plugins remove

EXAMPLES
  $ hd plugins uninstall myplugin

See code: @oclif/plugin-plugins

`hd plugins unlink [PLUGIN]`

Removes a plugin from the CLI.

USAGE
  $ hd plugins unlink [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ hd plugins unlink
  $ hd plugins remove

EXAMPLES
  $ hd plugins unlink myplugin

`hd plugins update`

Update installed plugins.

USAGE
  $ hd plugins update [-h] [-v]

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

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

`hd stage create`

Create a new stage

USAGE
  $ hd stage create [-a <value>] [--autoLaunch] [-b <value>] [--defaultStage] [--deletionProtection] [-d <value>]
    [-n <value>] [--production] [-p <value>] [--provider <value>] [-r <value>]

FLAGS
  -a, --accountId=<value>   AWS Account ID for deployments
  -b, --branchName=<value>  Git branch name
  -d, --domain=<value>      Tenant domain (for multi-domain setups)
  -n, --name=<value>        Name of the stage (e.g., dev, staging, production)
  -p, --project=<value>...  Project slugs to associate with this stage
  -r, --region=<value>...   AWS region(s) for deployment
      --autoLaunch          Automatically launch deployments for this stage
      --defaultStage        Set as default stage for fallback
      --deletionProtection  Enable deletion protection
      --production          Mark as production stage
      --provider=<value>    [default: aws] Cloud provider

DESCRIPTION
  Create a new stage

See code: src/commands/stage/create.ts

`hd stage list`

List all stages

USAGE
  $ hd stage list [-d <value>]

FLAGS
  -d, --domain=<value>  Tenant domain (for multi-domain setups)

DESCRIPTION
  List all stages

EXAMPLES
  $ hd stage list

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

`hd test-api`

Test API connection with SigV4 authentication

USAGE
  $ hd test-api [-d <value>]

FLAGS
  -d, --domain=<value>  Tenant domain (for multi-domain setups)

DESCRIPTION
  Test API connection with SigV4 authentication

EXAMPLES
  $ hd test-api

See code: src/commands/test-api.ts

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

hd

Usage

Commands

hd account add

hd account list

hd account remove

hd auth login

hd auth logout

hd auth refresh

hd auth status

hd ci account create

hd ci account delete [ACCOUNTID]

hd ci account list

hd config get KEY

hd config set KEY VALUE

hd config show

hd deployment create

hd deployment get

hd deployment launch

hd deployment list

hd domain current

hd domain list

hd domain switch DOMAIN

hd example [FILE]

hd git connect

hd git disconnect

hd git list

hd git sync

hd help [COMMAND]

hd init

hd jira connect

hd jira status

hd module analyze

hd module create

hd module destroy

hd module get

hd module link

hd module list

hd module reanalyze

hd module update

hd parameter add

hd parameter backfill

hd parameter clear

hd parameter list

hd parameter pull

hd parameter remove

hd parameter sync

hd parameter update

hd plugins

hd plugins add PLUGIN

hd plugins:inspect PLUGIN...

hd plugins install PLUGIN

hd plugins link PATH

hd plugins remove [PLUGIN]

hd plugins reset

hd plugins uninstall [PLUGIN]

hd plugins unlink [PLUGIN]

hd plugins update

hd stage create

hd stage list

hd test-api

`hd account add`

`hd account list`

`hd account remove`

`hd auth login`

`hd auth logout`

`hd auth refresh`

`hd auth status`

`hd ci account create`

`hd ci account delete [ACCOUNTID]`

`hd ci account list`

`hd config get KEY`

`hd config set KEY VALUE`

`hd config show`

`hd deployment create`

`hd deployment get`

`hd deployment launch`

`hd deployment list`

`hd domain current`

`hd domain list`

`hd domain switch DOMAIN`

`hd example [FILE]`

`hd git connect`

`hd git disconnect`

`hd git list`

`hd git sync`

`hd help [COMMAND]`

`hd init`

`hd jira connect`

`hd jira status`

`hd module analyze`

`hd module create`

`hd module destroy`

`hd module get`

`hd module link`

`hd module list`

`hd module reanalyze`

`hd module update`

`hd parameter add`

`hd parameter backfill`

`hd parameter clear`

`hd parameter list`

`hd parameter pull`

`hd parameter remove`

`hd parameter sync`

`hd parameter update`

`hd plugins`

`hd plugins add PLUGIN`

`hd plugins:inspect PLUGIN...`

`hd plugins install PLUGIN`

`hd plugins link PATH`

`hd plugins remove [PLUGIN]`

`hd plugins reset`

`hd plugins uninstall [PLUGIN]`

`hd plugins unlink [PLUGIN]`

`hd plugins update`

`hd stage create`

`hd stage list`

`hd test-api`