@hyperdrive.bot/cli
v1.0.18
Published
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:
Downloads
254
Readme
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.1 linux-x64 node-v22.22.3
$ hd --help [COMMAND]
USAGE
$ hd COMMAND
...Commands
hd deployment createhd deployment launchhd example [FILE]hd help [COMMAND]hd module createhd module destroy [FILE]hd module linkhd parameter add [FILE]hd parameter clear [FILE]hd parameter list [FILE]hd parameter remove [FILE]hd parameter synchd parameter update [FILE]hd pluginshd plugins add PLUGINhd plugins:inspect PLUGIN...hd plugins install PLUGINhd plugins link PATHhd plugins remove [PLUGIN]hd plugins resethd plugins uninstall [PLUGIN]hd plugins unlink [PLUGIN]hd plugins updatehd stage create
hd deployment create
Create a new deployment
USAGE
$ hd deployment create --token <value> -p <value> -s <value> -c <value> [-n <value>] [-r <value>] [--launch]
FLAGS
-c, --commit=<value> (required) Commit hash
-n, --name=<value> [default: Deployment-2026-05-22-20-57-43] The name of the deployment
-p, --projectSlug=<value> (required) Project slug
-r, --regions=<value>... [default: ] Regions for the deployment
-s, --stage=<value> (required) Stage for the deployment
--launch Launch the deployment after creating it
--token=<value> (required) Access token for authentication
DESCRIPTION
Create a new deployment
EXAMPLES
$ hd deployment create --name="Deployment 2024-05-10" --cloud="prod"
$ hd deployment create --cloud="dev"See code: src/commands/deployment/create.ts
hd deployment launch
Create a new deployment
USAGE
$ hd deployment launch --token <value> -p <value> -s <value> -r <value> [-n <value>]
FLAGS
-n, --name=<value> [default: Deployment-2026-05-22-20-57-43] The name of the deployment
-p, --projectSlug=<value> (required) Project slug
-r, --region=<value> (required) Region for the deployment
-s, --stage=<value> (required) Stage for the deployment
--token=<value> (required) Access token for authentication
DESCRIPTION
Create a new deployment
EXAMPLES
$ hd deployment launch --name="Deployment 2024-05-10" --cloud="prod"
$ hd deployment launch --cloud="dev"See code: src/commands/deployment/launch.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 exampleSee code: src/commands/example.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 module create
Create a new project
USAGE
$ hd module create --token <value> [--name <value>] [--slug <value>] [--sourceLocation <value>] [--buildFolder
<value>] [--ciService Github Actions|Gitlab CI|Travis CI|Circle CI|Jenkins] [--framework
Express.js|React.js|Serverless Framework|Serverless Stack|CDK|HTML5] [--buildCommand <value>] [--installCommand
<value>] [--runCommand <value>]
FLAGS
--buildCommand=<value> Build command
--buildFolder=<value> Build folder
--ciService=<option> CI service used
<options: Github Actions|Gitlab CI|Travis CI|Circle CI|Jenkins>
--framework=<option> Framework used
<options: Express.js|React.js|Serverless Framework|Serverless Stack|CDK|HTML5>
--installCommand=<value> Install command
--name=<value> Name of the project
--runCommand=<value> Run command
--slug=<value> Slug of the project
--sourceLocation=<value> Source location of the project
--token=<value> (required) Access token for authentication
DESCRIPTION
Create a new project
EXAMPLES
$ hd module create --name="New Project" --token="your_token_here" --slug="project-slug"See code: src/commands/module/create.ts
hd module destroy [FILE]
describe the command here
USAGE
$ hd module destroy [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 module destroySee code: src/commands/module/destroy.ts
hd module link
Links two modules using specified environment variables as connectors
USAGE
$ hd module link --originSlug <value> --targetSlug <value> --parameter <value> --token <value>
FLAGS
--originSlug=<value> (required) Slug of the origin module
--parameter=<value>... (required) Environment variable to link
--targetSlug=<value> (required) Slug of the target module
--token=<value> (required) Access token for authentication
DESCRIPTION
Links two modules using specified environment variables as connectors
EXAMPLES
$ hd module link --originSlug="origin-project" --targetSlug="destination-project" --envVar="VAR1" --envVar="VAR2"See code: src/commands/module/link.ts
hd parameter add [FILE]
describe the command here
USAGE
$ hd parameter add [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 parameter addSee code: src/commands/parameter/add.ts
hd parameter clear [FILE]
describe the command here
USAGE
$ hd parameter clear [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 parameter clearSee code: src/commands/parameter/clear.ts
hd parameter list [FILE]
describe the command here
USAGE
$ hd parameter list [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 parameter listSee code: src/commands/parameter/list.ts
hd parameter remove [FILE]
describe the command here
USAGE
$ hd parameter remove [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 parameter removeSee code: src/commands/parameter/remove.ts
hd parameter sync
Synchronize environment variables from a .env file to Hyperdrive service
USAGE
$ hd parameter sync --token <value> --accountId <value> [-f <value>] [-p <value>] [-s] [-t <value>] [--region
<value>] [--provider <value>]
FLAGS
-f, --file=<value> [default: .env] Path to the .env file
-p, --projectSlug=<value> Project slug
-s, --[no-]specific Whether the env vars are project-specific (default: true)
-t, --stage=<value> Stage for the env vars, if applicable
--accountId=<value> (required) Account ID
--provider=<value> [default: aws] Provider for the stage
--region=<value> Region
--token=<value> (required) Access token for authentication
DESCRIPTION
Synchronize environment variables from a .env file to Hyperdrive serviceSee code: src/commands/parameter/sync.ts
hd parameter update [FILE]
describe the command here
USAGE
$ hd parameter update [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 parameter updateSee 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 pluginsSee 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/somepluginhd 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 mypluginSee 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/somepluginSee 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 mypluginSee 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 mypluginhd 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 mypluginSee 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 mypluginhd 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 --name <value> --branchName <value> -r <value> -p <value> --token <value> [--provider <value>]
[--accountId <value>] [--production] [--deletionProtection] [--defaultStage]
FLAGS
-p, --project=<value>... (required) Projects to associate with the stage
-r, --region=<value>... (required) Region
--accountId=<value> [default: 913379445474] Account ID
--branchName=<value> (required) Branch name
--defaultStage Set as default stage
--deletionProtection Enable deletion protection
--name=<value> (required) Name of the stage
--production Set as production stage
--provider=<value> [default: aws] Provider for the stage
--token=<value> (required) Access token for authentication
DESCRIPTION
Create a new stageSee code: src/commands/stage/create.ts
