From c2a5155399077ea073ab611c44a507eda646b885 Mon Sep 17 00:00:00 2001 From: Ian Maddaus Date: Mon, 26 Sep 2022 14:06:58 -0400 Subject: [PATCH 1/2] Updates for Hab menu Signed-off-by: Ian Maddaus --- config/_default/menu.toml | 25 ++++++++++++++++--------- 1 file changed, 16 insertions(+), 9 deletions(-) diff --git a/config/_default/menu.toml b/config/_default/menu.toml index 93c8caba35..553e240696 100644 --- a/config/_default/menu.toml +++ b/config/_default/menu.toml @@ -314,21 +314,34 @@ identifier = "habitat" [[habitat]] title = "Install Habitat" - identifier = "habitat/get_started" + identifier = "habitat/install" parent = "habitat" weight = 10 + [[habitat]] + title = "Get Started" + identifier = "habitat/get_started" + parent = "habitat" + weight = 15 + [[habitat]] title = "Builder" identifier = "habitat/builder" parent = "habitat" weight = 20 + [[habitat]] + title = "Create a Builder Account" + identifier = "habitat/builder/builder-account" + parent = "habitat/builder" + weight = 20 + url = "habitat/builder_account/" + [[habitat]] title = "Origins" - identifier = "habitat/origins" + identifier = "habitat/builder/origins" parent = "habitat" - weight = 30 + weight = 40 [[habitat]] title = "Packages" @@ -371,12 +384,6 @@ identifier = "habitat" parent = "habitat" weight = 200 - [[habitat]] - title = "Diagrams" - identifier = "habitat/diagrams" - parent = "habitat" - weight = 500 - #### # End Chef Habitat Menu #### From 2a1057488875428a1192e765024bf6304e3a169f Mon Sep 17 00:00:00 2001 From: Ian Maddaus Date: Thu, 30 Mar 2023 12:25:02 -0400 Subject: [PATCH 2/2] Move hab cli page Signed-off-by: Ian Maddaus --- .../update_hugo_modules_project_promoted.sh | 1 + content/habitat/cli.md | 3778 +++++++++++++++++ content/habitat/habitat_cli.md | 3776 +--------------- 3 files changed, 3782 insertions(+), 3773 deletions(-) create mode 100644 content/habitat/cli.md diff --git a/.expeditor/update_hugo_modules_project_promoted.sh b/.expeditor/update_hugo_modules_project_promoted.sh index 4604bd514a..116378eaec 100644 --- a/.expeditor/update_hugo_modules_project_promoted.sh +++ b/.expeditor/update_hugo_modules_project_promoted.sh @@ -62,6 +62,7 @@ hugo mod clean if [[ "${EXPEDITOR_PROJECT}" == *"habitat"* ]]; then curl --silent --output generated-documentation.tar.gz https://packages.chef.io/files/${EXPEDITOR_TARGET_CHANNEL}/habitat/latest/generated-documentation.tar.gz tar xvzf generated-documentation.tar.gz --strip-components 1 -C content/habitat + mv content/habitat/habitat_cli.md content/habitat/cli.md rm generated-documentation.tar.gz fi diff --git a/content/habitat/cli.md b/content/habitat/cli.md new file mode 100644 index 0000000000..2576e5ceb1 --- /dev/null +++ b/content/habitat/cli.md @@ -0,0 +1,3778 @@ ++++ +title = "Chef Habitat Command-Line Interface (CLI) Reference" +draft= false +aliases=["/habitat/habitat_cli"] + +[menu] + [menu.habitat] + title = "Habitat CLI Reference" + identifier = "habitat/reference/Habitat CLI Reference" + parent = "habitat/reference" + weight = 10 ++++ + + + + + +The commands for the Chef Habitat CLI (`hab`) are listed below. + +| Applies to Version | Last Updated | +| ------- | ------------ | +| hab 1.6.652/20230206155653 (linux) | 6 Feb 2023 | + +## hab + + + +**USAGE** + +``` +hab +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + + + +**ALIASES** + +``` +apply Alias for: 'config apply' +install Alias for: 'pkg install' +run Alias for: 'sup run' +setup Alias for: 'cli setup' +start Alias for: 'svc start' +stop Alias for: 'svc stop' +term Alias for: 'sup term' +``` + +**SUBCOMMANDS** + +| Command | Description | +| ------- | ----------- | +| [hab bldr](#hab-bldr) | Commands relating to Habitat Builder | +| [hab cli](#hab-cli) | Commands relating to Habitat runtime config | +| [hab config](#hab-config) | Commands relating to a Service's runtime config | +| [hab file](#hab-file) | Commands relating to Habitat files | +| [hab license](#hab-license) | Commands relating to Habitat license agreements | +| [hab origin](#hab-origin) | Commands relating to Habitat Builder origins | +| [hab pkg](#hab-pkg) | Commands relating to Habitat packages | +| [hab plan](#hab-plan) | Commands relating to plans and other app-specific configuration | +| [hab ring](#hab-ring) | Commands relating to Habitat rings | +| [hab studio](#hab-studio) | Commands relating to Habitat Studios | +| [hab sup](#hab-sup) | The Habitat Supervisor | +| [hab supportbundle](#hab-supportbundle) | Create a tarball of Habitat Supervisor data to send to support | +| [hab svc](#hab-svc) | Commands relating to Habitat services | +| [hab user](#hab-user) | Commands relating to Habitat users | +--- + +## hab bldr + +Commands relating to Habitat Builder + +**USAGE** + +``` +hab bldr +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + + + + +**SUBCOMMANDS** + +| Command | Description | +| ------- | ----------- | +| [hab bldr channel](#hab-bldr-channel) | Commands relating to Habitat Builder channels | +| [hab bldr job](#hab-bldr-job) | Commands relating to Habitat Builder jobs | +--- + +### hab bldr channel + +Commands relating to Habitat Builder channels + +**USAGE** + +``` +hab bldr channel +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + + + + +**SUBCOMMANDS** + +| Command | Description | +| ------- | ----------- | +| [hab bldr channel create](#hab-bldr-channel-create) | Creates a new channel | +| [hab bldr channel demote](#hab-bldr-channel-demote) | Atomically demotes selected packages in a target channel | +| [hab bldr channel destroy](#hab-bldr-channel-destroy) | Destroys a channel | +| [hab bldr channel list](#hab-bldr-channel-list) | Lists origin channels | +| [hab bldr channel promote](#hab-bldr-channel-promote) | Atomically promotes all packages in channel | +--- + +### hab bldr channel create + +Creates a new channel + +**USAGE** + +``` +hab bldr channel create [OPTIONS] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) +-o, --origin Sets the origin to which the channel will belong. Default is from 'HAB_ORIGIN' or cli.toml +``` + +**ARGS** + +``` + The channel name +``` + + + +--- + +### hab bldr channel demote + +Atomically demotes selected packages in a target channel + +**USAGE** + +``` +hab bldr channel demote [OPTIONS] --origin +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-z, --auth Authentication token for Builder +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) +-o, --origin The origin for the channels. Default is from 'HAB_ORIGIN' or cli.toml +``` + +**ARGS** + +``` + The channel from which all packages will be selected for demotion + The channel selected packages will be removed from +``` + + + +--- + +### hab bldr channel destroy + +Destroys a channel + +**USAGE** + +``` +hab bldr channel destroy [OPTIONS] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) +-o, --origin Sets the origin to which the channel belongs. Default is from 'HAB_ORIGIN' or cli.toml +``` + +**ARGS** + +``` + The channel name +``` + + + +--- + +### hab bldr channel list + +Lists origin channels + +**USAGE** + +``` +hab bldr channel list [FLAGS] [OPTIONS] [ORIGIN] +``` + +**FLAGS** + +``` +-s, --sandbox Include sandbox channels for the origin +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) +``` + +**ARGS** + +``` + The origin for which channels will be listed. Default is from 'HAB_ORIGIN' or cli.toml +``` + + + +--- + +### hab bldr channel promote + +Atomically promotes all packages in channel + +**USAGE** + +``` +hab bldr channel promote [OPTIONS] --origin +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-z, --auth Authentication token for Builder +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) +-o, --origin The origin for the channels. Default is from 'HAB_ORIGIN' or cli.toml +``` + +**ARGS** + +``` + The channel from which all packages will be selected for promotion + The channel to which packages will be promoted +``` + + + +--- + +### hab bldr job + +Commands relating to Habitat Builder jobs + +**USAGE** + +``` +hab bldr job +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + + + + +**SUBCOMMANDS** + +| Command | Description | +| ------- | ----------- | +| [hab bldr job cancel](#hab-bldr-job-cancel) | Cancel a build job group and any in-progress builds | +| [hab bldr job demote](#hab-bldr-job-demote) | Demote packages from a completed build job from a specified channel | +| [hab bldr job promote](#hab-bldr-job-promote) | Promote packages from a completed build job to a specified channel | +| [hab bldr job start](#hab-bldr-job-start) | Schedule a build job or group of jobs | +| [hab bldr job status](#hab-bldr-job-status) | Get the status of one or more job groups | +--- + +### hab bldr job cancel + +Cancel a build job group and any in-progress builds + +**USAGE** + +``` +hab bldr job cancel [FLAGS] [OPTIONS] +``` + +**FLAGS** + +``` +-f, --force Don't prompt for confirmation +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-z, --auth Authentication token for Builder +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) +``` + +**ARGS** + +``` + The job group id that was returned from "hab bldr job start" (ex: 771100000000000000) +``` + + + +--- + +### hab bldr job demote + +Demote packages from a completed build job from a specified channel + +**USAGE** + +``` +hab bldr job demote [FLAGS] [OPTIONS] +``` + +**FLAGS** + +``` +-i, --interactive Allow editing the list of demotable packages +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-z, --auth Authentication token for Builder +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) +-o, --origin Limit the demotable packages to the specified origin +``` + +**ARGS** + +``` + The job group id that was returned from "hab bldr job start" (ex: 771100000000000000) + The name of the channel to demote from +``` + + + +--- + +### hab bldr job promote + +Promote packages from a completed build job to a specified channel + +**USAGE** + +``` +hab bldr job promote [FLAGS] [OPTIONS] +``` + +**FLAGS** + +``` +-i, --interactive Allow editing the list of promotable packages +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-z, --auth Authentication token for Builder +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) +-o, --origin Limit the promotable packages to the specified origin +``` + +**ARGS** + +``` + The job group id that was returned from "hab bldr job start" (ex: 771100000000000000) + The target channel name +``` + + + +--- + +### hab bldr job start + +Schedule a build job or group of jobs + +**USAGE** + +``` +hab bldr job start [FLAGS] [OPTIONS] [PKG_TARGET] +``` + +**FLAGS** + +``` +-g, --group Schedule jobs for this package and all of its reverse dependencies +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-z, --auth Authentication token for Builder +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) +``` + +**ARGS** + +``` + A package identifier (ex: core/redis, core/busybox-static/1.42.2) + A package target (ex: x86_64-windows) (default: system appropriate target) [env: HAB_PACKAGE_TARGET=] +``` + + + +--- + +### hab bldr job status + +Get the status of one or more job groups + +**USAGE** + +``` +hab bldr job status [FLAGS] [OPTIONS] > +``` + +**FLAGS** + +``` +-s, --showjobs Show the status of all build jobs for a retrieved job group +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) +-l, --limit Limit how many job groups to retrieve, ordered by most recent (default: 10) +-o, --origin Show the status of recent job groups created in this origin (default: 10 most recent) +``` + +**ARGS** + +``` + The job group id that was returned from "hab bldr job start" (ex: 771100000000000000) +``` + + + +--- + +## hab cli + +Commands relating to Habitat runtime config + +**USAGE** + +``` +hab cli +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + + + + +**SUBCOMMANDS** + +| Command | Description | +| ------- | ----------- | +| [hab cli completers](#hab-cli-completers) | Creates command-line completers for your shell | +| [hab cli setup](#hab-cli-setup) | Sets up the CLI with reasonable defaults | +--- + +### hab cli completers + +Creates command-line completers for your shell + +**USAGE** + +``` +hab cli completers --shell +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-s, --shell The name of the shell you want to generate the command-completion [possible values: Bash, Fish, Zsh, PowerShell] +``` + + + + +--- + +### hab cli setup + +Sets up the CLI with reasonable defaults + +**USAGE** + +``` +hab cli setup [OPTIONS] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +--cache-key-path Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=] [default: /hab/cache/keys] +``` + + + + +--- + +## hab config + +Commands relating to a Service's runtime config + +**USAGE** + +``` +hab config +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + + + + +**SUBCOMMANDS** + +| Command | Description | +| ------- | ----------- | +| [hab config apply](#hab-config-apply) | Sets a configuration to be shared by members of a Service Group | +| [hab config show](#hab-config-show) | Displays the default configuration options for a service | +--- + +### hab config apply + +Sets a configuration to be shared by members of a Service Group + +**USAGE** + +``` +hab config apply [OPTIONS] [FILE] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +--cache-key-path Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=] [default: /hab/cache/keys] +-r, --remote-sup Address to a remote Supervisor's Control Gateway [default: 127.0.0.1:9632] +-u, --user Name of a user key to use for encryption +``` + +**ARGS** + +``` + Target service group service.group[@organization] (ex: redis.default or foo.default@bazcorp) + A version number (positive integer) for this configuration (ex: 42) + Path to local file on disk (ex: /tmp/config.toml, default: ) +``` + + + +--- + +### hab config show + +Displays the default configuration options for a service + +**USAGE** + +``` +hab config show [OPTIONS] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-r, --remote-sup Address to a remote Supervisor's Control Gateway [default: 127.0.0.1:9632] +``` + +**ARGS** + +``` + A package identifier (ex: core/redis, core/busybox-static/1.42.2) +``` + + + +--- + +## hab file + +Commands relating to Habitat files + +**USAGE** + +``` +hab file +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + + + + +**SUBCOMMANDS** + +| Command | Description | +| ------- | ----------- | +| [hab file upload](#hab-file-upload) | Uploads a file to be shared between members of a Service Group | +--- + +### hab file upload + +Uploads a file to be shared between members of a Service Group + +**USAGE** + +``` +hab file upload [OPTIONS] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +--cache-key-path Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=] [default: /hab/cache/keys] +-r, --remote-sup Address to a remote Supervisor's Control Gateway [default: 127.0.0.1:9632] +-u, --user Name of the user key +``` + +**ARGS** + +``` + Target service group service.group[@organization] (ex: redis.default or foo.default@bazcorp) + A version number (positive integer) for this configuration (ex: 42) + Path to local file on disk +``` + + + +--- + +## hab license + +Commands relating to Habitat license agreements + +**USAGE** + +``` +hab license +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + + + + +**SUBCOMMANDS** + +| Command | Description | +| ------- | ----------- | +| [hab license accept](#hab-license-accept) | Accept the Chef Binary Distribution Agreement without prompting | +--- + +### hab license accept + +Accept the Chef Binary Distribution Agreement without prompting + +**USAGE** + +``` +hab license accept +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + + + + + +--- + +## hab origin + +Commands relating to Habitat Builder origins + +**USAGE** + +``` +hab origin +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + + + + +**SUBCOMMANDS** + +| Command | Description | +| ------- | ----------- | +| [hab origin create](#hab-origin-create) | Creates a new Builder origin | +| [hab origin delete](#hab-origin-delete) | Removes an unused/empty origin | +| [hab origin depart](#hab-origin-depart) | Departs membership from selected origin | +| [hab origin info](#hab-origin-info) | Displays general information about an origin | +| [hab origin invitations](#hab-origin-invitations) | Manage origin member invitations | +| [hab origin key](#hab-origin-key) | Commands relating to Habitat origin key maintenance | +| [hab origin rbac](#hab-origin-rbac) | Role Based Access Control for origin members | +| [hab origin secret](#hab-origin-secret) | Commands related to secret management | +| [hab origin transfer](#hab-origin-transfer) | Transfers ownership of an origin to another member of that origin | +--- + +### hab origin create + +Creates a new Builder origin + +**USAGE** + +``` +hab origin create [OPTIONS] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-z, --auth Authentication token for Builder +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) +``` + +**ARGS** + +``` + The origin to be created +``` + + + +--- + +### hab origin delete + +Removes an unused/empty origin + +**USAGE** + +``` +hab origin delete [OPTIONS] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-z, --auth Authentication token for Builder +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) +``` + +**ARGS** + +``` + The origin name +``` + + + +--- + +### hab origin depart + +Departs membership from selected origin + +**USAGE** + +``` +hab origin depart [OPTIONS] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-z, --auth Authentication token for Builder +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) +``` + +**ARGS** + +``` + The origin name +``` + + + +--- + +### hab origin info + +Displays general information about an origin + +**USAGE** + +``` +hab origin info [FLAGS] [OPTIONS] +``` + +**FLAGS** + +``` +-j, --json Output will be rendered in json +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-z, --auth Authentication token for Builder +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) +``` + +**ARGS** + +``` + The origin name to be queried +``` + + + +--- + +### hab origin invitations + +Manage origin member invitations + +**USAGE** + +``` +hab origin invitations +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + + + + +**SUBCOMMANDS** + +| Command | Description | +| ------- | ----------- | +| [hab origin invitations accept](#hab-origin-invitations-accept) | Accept an origin member invitation | +| [hab origin invitations ignore](#hab-origin-invitations-ignore) | Ignore an origin member invitation | +| [hab origin invitations list](#hab-origin-invitations-list) | List origin invitations sent to your account | +| [hab origin invitations pending](#hab-origin-invitations-pending) | List pending invitations for a particular origin. Requires that you are the origin owner | +| [hab origin invitations rescind](#hab-origin-invitations-rescind) | Rescind an existing origin member invitation | +| [hab origin invitations send](#hab-origin-invitations-send) | Send an origin member invitation | +--- + +### hab origin invitations accept + +Accept an origin member invitation + +**USAGE** + +``` +hab origin invitations accept [OPTIONS] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-z, --auth Authentication token for Builder +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) +``` + +**ARGS** + +``` + The origin name the invitation applies to + The id of the invitation to accept +``` + + + +--- + +### hab origin invitations ignore + +Ignore an origin member invitation + +**USAGE** + +``` +hab origin invitations ignore [OPTIONS] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-z, --auth Authentication token for Builder +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) +``` + +**ARGS** + +``` + The origin name the invitation applies to + The id of the invitation to ignore +``` + + + +--- + +### hab origin invitations list + +List origin invitations sent to your account + +**USAGE** + +``` +hab origin invitations list [OPTIONS] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-z, --auth Authentication token for Builder +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) +``` + + + + +--- + +### hab origin invitations pending + +List pending invitations for a particular origin. Requires that you are the origin owner + +**USAGE** + +``` +hab origin invitations pending [OPTIONS] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-z, --auth Authentication token for Builder +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) +``` + +**ARGS** + +``` + The name of the origin you wish to list invitations for +``` + + + +--- + +### hab origin invitations rescind + +Rescind an existing origin member invitation + +**USAGE** + +``` +hab origin invitations rescind [OPTIONS] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-z, --auth Authentication token for Builder +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) +``` + +**ARGS** + +``` + The origin name the invitation applies to + The id of the invitation to rescind +``` + + + +--- + +### hab origin invitations send + +Send an origin member invitation + +**USAGE** + +``` +hab origin invitations send [OPTIONS] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-z, --auth Authentication token for Builder +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) +``` + +**ARGS** + +``` + The origin name the invitation applies to + The account name to invite into the origin +``` + + + +--- + +### hab origin key + +Commands relating to Habitat origin key maintenance + +**USAGE** + +``` +hab origin key +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + + + + +**SUBCOMMANDS** + +| Command | Description | +| ------- | ----------- | +| [hab origin key download](#hab-origin-key-download) | Download origin key(s) | +| [hab origin key export](#hab-origin-key-export) | Outputs the latest origin key contents to stdout | +| [hab origin key generate](#hab-origin-key-generate) | Generates a Habitat origin key pair | +| [hab origin key import](#hab-origin-key-import) | Reads a stdin stream containing a public or private origin key contents and writes the key to disk | +| [hab origin key upload](#hab-origin-key-upload) | Upload origin keys to Builder | +--- + +### hab origin key download + +Download origin key(s) + +**USAGE** + +``` +hab origin key download [FLAGS] [OPTIONS] [REVISION] +``` + +**FLAGS** + +``` +-e, --encryption Download public encryption key instead of origin public key +-s, --secret Download origin private key instead of origin public key +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-z, --auth Authentication token for Builder (required for downloading origin private keys) +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) + --cache-key-path Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=] [default: /hab/cache/keys] +``` + +**ARGS** + +``` + The origin name + The origin key revision +``` + + + +--- + +### hab origin key export + +Outputs the latest origin key contents to stdout + +**USAGE** + +``` +hab origin key export [OPTIONS] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +--cache-key-path Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=] [default: /hab/cache/keys] +-t, --type Export either the 'public' or 'secret' key. The 'secret' key is the origin private key +``` + +**ARGS** + +``` + The origin name +``` + + + +--- + +### hab origin key generate + +Generates a Habitat origin key pair + +**USAGE** + +``` +hab origin key generate [OPTIONS] [ORIGIN] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +--cache-key-path Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=] [default: /hab/cache/keys] +``` + +**ARGS** + +``` + The origin name +``` + + + +--- + +### hab origin key import + +Reads a stdin stream containing a public or private origin key contents and writes the key to disk + +**USAGE** + +``` +hab origin key import [OPTIONS] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +--cache-key-path Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=] [default: /hab/cache/keys] +``` + + + + +--- + +### hab origin key upload + +Upload origin keys to Builder + +**USAGE** + +``` +hab origin key upload [FLAGS] [OPTIONS] > +``` + +**FLAGS** + +``` +-s, --secret Upload origin private key in addition to the public key +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-z, --auth Authentication token for Builder +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) + --cache-key-path Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=] [default: /hab/cache/keys] + --pubfile Path to a local public origin key file on disk + --secfile Path to a local origin private key file on disk +``` + +**ARGS** + +``` + The origin name +``` + + + +--- + +### hab origin rbac + +Role Based Access Control for origin members + +**USAGE** + +``` +hab origin rbac +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + + + + +**SUBCOMMANDS** + +| Command | Description | +| ------- | ----------- | +| [hab origin rbac set](#hab-origin-rbac-set) | Change an origin member's role | +| [hab origin rbac show](#hab-origin-rbac-show) | Display an origin member's current role | +--- + +### hab origin rbac set + +Change an origin member's role + +**USAGE** + +``` +hab origin rbac set [FLAGS] [OPTIONS] --origin +``` + +**FLAGS** + +``` +-n, --no-prompt Do not prompt for confirmation +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-z, --auth Authentication token for Builder +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) +-o, --origin The Builder origin name to target +``` + +**ARGS** + +``` + The account name whose role will be changed + The role name to enforce for the member account [possible values: readonly_member, member, maintainer, administrator, owner] +``` + + + +--- + +### hab origin rbac show + +Display an origin member's current role + +**USAGE** + +``` +hab origin rbac show [FLAGS] [OPTIONS] --origin +``` + +**FLAGS** + +``` +-j, --json Output will be rendered in json +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-z, --auth Authentication token for Builder +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) +-o, --origin The Builder origin name to target +``` + +**ARGS** + +``` + The account name of the role to display +``` + + + +--- + +### hab origin secret + +Commands related to secret management + +**USAGE** + +``` +hab origin secret +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + + + + +**SUBCOMMANDS** + +| Command | Description | +| ------- | ----------- | +| [hab origin secret delete](#hab-origin-secret-delete) | Delete a secret for your origin | +| [hab origin secret list](#hab-origin-secret-list) | List all secrets for your origin | +| [hab origin secret upload](#hab-origin-secret-upload) | Create and upload a secret for your origin | +--- + +### hab origin secret delete + +Delete a secret for your origin + +**USAGE** + +``` +hab origin secret delete [OPTIONS] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-z, --auth Authentication token for Builder +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) +-o, --origin The origin for which the secret will be deleted. Default is from 'HAB_ORIGIN' or cli.toml +``` + +**ARGS** + +``` + The name of the variable key to be injected into the studio +``` + + + +--- + +### hab origin secret list + +List all secrets for your origin + +**USAGE** + +``` +hab origin secret list [OPTIONS] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-z, --auth Authentication token for Builder +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) +-o, --origin The origin for which secrets will be listed. Default is from 'HAB_ORIGIN' or cli.toml +``` + + + + +--- + +### hab origin secret upload + +Create and upload a secret for your origin + +**USAGE** + +``` +hab origin secret upload [OPTIONS] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-z, --auth Authentication token for Builder +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) + --cache-key-path Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=] [default: /hab/cache/keys] +-o, --origin The origin for which the secret will be uploaded. Default is from HAB_ORIGIN' or cli.toml +``` + +**ARGS** + +``` + The name of the variable key to be injected into the studio. Ex: KEY="some_value" + The contents of the variable to be injected into the studio +``` + + + +--- + +### hab origin transfer + +Transfers ownership of an origin to another member of that origin + +**USAGE** + +``` +hab origin transfer [OPTIONS] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-z, --auth Authentication token for Builder +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) +``` + +**ARGS** + +``` + The origin name + The account name of the new origin owner +``` + + + +--- + +## hab pkg + +Commands relating to Habitat packages + +**USAGE** + +``` +hab pkg +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + + + + +**SUBCOMMANDS** + +| Command | Description | +| ------- | ----------- | +| [hab pkg binds](#hab-pkg-binds) | Displays the binds for a service | +| [hab pkg binlink](#hab-pkg-binlink) | Creates a binlink for a package binary in a common 'PATH' location | +| [hab pkg build](#hab-pkg-build) | Builds a Plan using a Studio | +| [hab pkg bulkupload](#hab-pkg-bulkupload) | Bulk Uploads Habitat Artifacts to a Depot from a local directory | +| [hab pkg channels](#hab-pkg-channels) | Find out what channels a package belongs to | +| [hab pkg config](#hab-pkg-config) | Displays the default configuration options for a service | +| [hab pkg delete](#hab-pkg-delete) | Removes a package from Builder | +| [hab pkg demote](#hab-pkg-demote) | Demote a package from a specified channel | +| [hab pkg dependencies](#hab-pkg-dependencies) | Returns the Habitat Artifact dependencies. By default it will return the direct dependencies of the package | +| [hab pkg download](#hab-pkg-download) | Download Habitat artifacts (including dependencies and keys) from Builder | +| [hab pkg env](#hab-pkg-env) | Prints the runtime environment of a specific installed package | +| [hab pkg exec](#hab-pkg-exec) | Executes a command using the 'PATH' context of an installed package | +| [hab pkg export](#hab-pkg-export) | Exports the package to the specified format | +| [hab pkg hash](#hab-pkg-hash) | Generates a blake2b hashsum from a target at any given filepath | +| [hab pkg info](#hab-pkg-info) | Returns the Habitat Artifact information | +| [hab pkg install](#hab-pkg-install) | Installs a Habitat package from Builder or locally from a Habitat Artifact | +| [hab pkg list](#hab-pkg-list) | List all versions of installed packages | +| [hab pkg path](#hab-pkg-path) | Prints the path to a specific installed release of a package | +| [hab pkg promote](#hab-pkg-promote) | Promote a package to a specified channel | +| [hab pkg provides](#hab-pkg-provides) | Search installed Habitat packages for a given file | +| [hab pkg search](#hab-pkg-search) | Search for a package in Builder | +| [hab pkg sign](#hab-pkg-sign) | Signs an archive with an origin key, generating a Habitat Artifact | +| [hab pkg uninstall](#hab-pkg-uninstall) | Safely uninstall a package and dependencies from the local filesystem | +| [hab pkg upload](#hab-pkg-upload) | Uploads a local Habitat Artifact to Builder | +| [hab pkg verify](#hab-pkg-verify) | Verifies a Habitat Artifact with an origin key | +--- + +### hab pkg binds + +Displays the binds for a service + +**USAGE** + +``` +hab pkg binds +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + + +**ARGS** + +``` + A package identifier (ex: core/redis, core/busybox-static/1.42.2) +``` + + + +--- + +### hab pkg binlink + +Creates a binlink for a package binary in a common 'PATH' location + +**USAGE** + +``` +hab pkg binlink [FLAGS] [OPTIONS] [BINARY] +``` + +**FLAGS** + +``` +-f, --force Overwrite existing binlinks +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-d, --dest Sets the destination directory [env: HAB_BINLINK_DIR=] [default: /bin] +``` + +**ARGS** + +``` + A package identifier (ex: core/redis, core/busybox-static/1.42.2) + The command to binlink (ex: bash) +``` + + + +--- + +### hab pkg build + +Builds a Plan using a Studio + +**USAGE** + +``` +hab pkg build [FLAGS] [OPTIONS] +``` + +**FLAGS** + +``` +-D, --docker Uses a Dockerized Studio for the build +-N, --native-package Build a native package on the host system without a studio +-R, --reuse Reuses a previous Studio for the build (default: clean up before building) +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +--cache-key-path Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=] [default: /hab/cache/keys] +-k, --keys Installs secret origin keys (ex: "unicorn", "acme,other,acme-ops") +-r, --root Sets the Studio root (default: /hab/studios/) +-s, --src Sets the source path (default: $PWD) +``` + +**ARGS** + +``` + A directory containing a plan file or a habitat/ directory which contains the plan file +``` + + + +--- + +### hab pkg bulkupload + +Bulk Uploads Habitat Artifacts to a Depot from a local directory + +**USAGE** + +``` +hab pkg bulkupload [FLAGS] [OPTIONS] +``` + +**FLAGS** + +``` +--auto-build Enable auto-build for all packages in this upload. Only applicable to SaaS Builder + --auto-create-origins Skip the confirmation prompt and automatically create origins that do not exist in the target Builder + --force Skip checking availability of package and force uploads, potentially overwriting a stored copy of a package +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-z, --auth Authentication token for Builder +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) +-c, --channel Optional additional release channel to upload package to. Packages are always uploaded to unstable, regardless of the value of this option +``` + +**ARGS** + +``` + Directory Path from which artifacts will be uploaded +``` + + + +--- + +### hab pkg channels + +Find out what channels a package belongs to + +**USAGE** + +``` +hab pkg channels [OPTIONS] [PKG_TARGET] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-z, --auth Authentication token for Builder +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) +``` + +**ARGS** + +``` + A fully qualified package identifier (ex: core/busybox-static/1.42.2/20170513215502) + A package target (ex: x86_64-windows) (default: system appropriate target) [env: HAB_PACKAGE_TARGET=] +``` + + + +--- + +### hab pkg config + +Displays the default configuration options for a service + +**USAGE** + +``` +hab pkg config +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + + +**ARGS** + +``` + A package identifier (ex: core/redis, core/busybox-static/1.42.2) +``` + + + +--- + +### hab pkg delete + +Removes a package from Builder + +**USAGE** + +``` +hab pkg delete [OPTIONS] [PKG_TARGET] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-z, --auth Authentication token for Builder +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) +``` + +**ARGS** + +``` + A fully qualified package identifier (ex: core/busybox-static/1.42.2/20170513215502) + A package target (ex: x86_64-windows) (default: system appropriate target) [env: HAB_PACKAGE_TARGET=] +``` + + + +--- + +### hab pkg demote + +Demote a package from a specified channel + +**USAGE** + +``` +hab pkg demote [OPTIONS] [PKG_TARGET] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-z, --auth Authentication token for Builder +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) +``` + +**ARGS** + +``` + A fully qualified package identifier (ex: core/busybox-static/1.42.2/20170513215502) + Demote from the specified release channel + A package target (ex: x86_64-windows) (default: system appropriate target) [env: HAB_PACKAGE_TARGET=] +``` + + + +--- + +### hab pkg dependencies + +Returns the Habitat Artifact dependencies. By default it will return the direct dependencies of the package + +**USAGE** + +``` +hab pkg dependencies [FLAGS] +``` + +**FLAGS** + +``` +-r, --reverse Show packages which are dependant on this one +-t, --transitive Show transitive dependencies +-h, --help Prints help information +-V, --version Prints version information +``` + + +**ARGS** + +``` + A package identifier (ex: core/redis, core/busybox-static/1.42.2) +``` + + + +--- + +### hab pkg download + +Download Habitat artifacts (including dependencies and keys) from Builder + +**USAGE** + +``` +hab pkg download [FLAGS] [OPTIONS] [--] [PKG_IDENT]... +``` + +**FLAGS** + +``` +--ignore-missing-seeds Ignore packages specified that are not present on the target Builder + --verify Verify package integrity after download (Warning: this can be slow) +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-z, --auth Authentication token for Builder +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) +-c, --channel Download from the specified release channel. Overridden if channel is specified in toml file [env: HAB_BLDR_CHANNEL=] [default: stable] + --download-directory The path to store downloaded artifacts + --file ... File with newline separated package identifiers, or TOML file (ending with .toml extension) + +-t, --target Target architecture to fetch. E.g. x86_64-linux. Overridden if architecture is specified in toml file +``` + +**ARGS** + +``` +... One or more Habitat package identifiers (ex: acme/redis) +``` + + + +--- + +### hab pkg env + +Prints the runtime environment of a specific installed package + +**USAGE** + +``` +hab pkg env +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + + +**ARGS** + +``` + A package identifier (ex: core/redis, core/busybox-static/1.42.2) +``` + + + +--- + +### hab pkg exec + +Executes a command using the 'PATH' context of an installed package + +**USAGE** + +``` +hab pkg exec [ARGS]... +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + + +**ARGS** + +``` + A package identifier (ex: core/redis, core/busybox-static/1.42.2) + The command to execute (ex: ls) +... Arguments to the command +``` + + + +--- + +### hab pkg export + +Exports the package to the specified format + +**USAGE** + +``` +hab pkg export +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + + + + +**SUBCOMMANDS** + +| Command | Description | +| ------- | ----------- | +| [hab pkg export cf](#hab-pkg-export-cf) | Cloud Foundry exporter | +| [hab pkg export container](#hab-pkg-export-container) | Container exporter | +| [hab pkg export mesos](#hab-pkg-export-mesos) | Mesos exporter | +| [hab pkg export tar](#hab-pkg-export-tar) | Tar exporter | +--- + +### hab pkg hash + +Generates a blake2b hashsum from a target at any given filepath + +**USAGE** + +``` +hab pkg hash [SOURCE] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + + +**ARGS** + +``` + A filepath of the target +``` + + + +--- + +### hab pkg info + +Returns the Habitat Artifact information + +**USAGE** + +``` +hab pkg info [FLAGS] +``` + +**FLAGS** + +``` +-j, --json Output will be rendered in json. (Includes extended metadata) +-h, --help Prints help information +-V, --version Prints version information +``` + + +**ARGS** + +``` + A path to a Habitat Artifact (ex: /home/acme-redis-3.0.7-21120102031201-x86_64-linux.hart) +``` + + + +--- + +### hab pkg install + +Installs a Habitat package from Builder or locally from a Habitat Artifact + +**USAGE** + +``` +hab pkg install [FLAGS] [OPTIONS] ... +``` + +**FLAGS** + +``` +-b, --binlink Binlink all binaries from installed package(s) into BINLINK_DIR +-f, --force Overwrite existing binlinks + --ignore-install-hook Do not run any install hooks +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-z, --auth Authentication token for Builder + --binlink-dir Binlink all binaries from installed package(s) into BINLINK_DIR [env: HAB_BINLINK_DIR=] [default: /bin] +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) +-c, --channel Install from the specified release channel [env: HAB_BLDR_CHANNEL=] [default: stable] +``` + +**ARGS** + +``` +... One or more Habitat package identifiers (ex: acme/redis) and/or filepaths to a Habitat Artifact (ex: /home/acme-redis-3.0.7-21120102031201-x86_64-linux.hart) +``` + + + +--- + +### hab pkg list + +List all versions of installed packages + +**USAGE** + +``` +hab pkg list [OPTIONS] <--all|--origin |PKG_IDENT> +``` + +**FLAGS** + +``` +-a, --all List all installed packages +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-o, --origin An origin to list +``` + +**ARGS** + +``` + A package identifier (ex: core/redis, core/busybox-static/1.42.2) +``` + + + +--- + +### hab pkg path + +Prints the path to a specific installed release of a package + +**USAGE** + +``` +hab pkg path +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + + +**ARGS** + +``` + A package identifier (ex: core/redis, core/busybox-static/1.42.2) +``` + + + +--- + +### hab pkg promote + +Promote a package to a specified channel + +**USAGE** + +``` +hab pkg promote [OPTIONS] [PKG_TARGET] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-z, --auth Authentication token for Builder +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) +``` + +**ARGS** + +``` + A fully qualified package identifier (ex: core/busybox-static/1.42.2/20170513215502) + Promote to the specified release channel + A package target (ex: x86_64-windows) (default: system appropriate target) [env: HAB_PACKAGE_TARGET=] +``` + + + +--- + +### hab pkg provides + +Search installed Habitat packages for a given file + +**USAGE** + +``` +hab pkg provides [FLAGS] +``` + +**FLAGS** + +``` +-p Show full path to file +-r Show fully qualified package names (ex: core/busybox-static/1.24.2/20160708162350) +-h, --help Prints help information +-V, --version Prints version information +``` + + +**ARGS** + +``` + File name to find +``` + + + +--- + +### hab pkg search + +Search for a package in Builder + +**USAGE** + +``` +hab pkg search [OPTIONS] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-z, --auth Authentication token for Builder +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) +-l, --limit Limit how many packages to retrieve [default: 50] +``` + +**ARGS** + +``` + Search term +``` + + + +--- + +### hab pkg sign + +Signs an archive with an origin key, generating a Habitat Artifact + +**USAGE** + +``` +hab pkg sign [OPTIONS] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +--cache-key-path Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=] [default: /hab/cache/keys] + --origin Origin key used to create signature +``` + +**ARGS** + +``` + A path to a source archive file (ex: /home/acme-redis-3.0.7-21120102031201.tar.xz) + The destination path to the signed Habitat Artifact (ex: /home/acme-redis-3.0.7-21120102031201- x86_64-linux.hart) +``` + + + +--- + +### hab pkg uninstall + +Safely uninstall a package and dependencies from the local filesystem + +**USAGE** + +``` +hab pkg uninstall [FLAGS] [OPTIONS] +``` + +**FLAGS** + +``` +-d, --dryrun Just show what would be uninstalled, don't actually do it + --ignore-uninstall-hook Do not run any uninstall hooks + --no-deps Don't uninstall dependencies +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +--exclude ... Identifier of one or more packages that should not be uninstalled. (ex: core/redis, core/busybox-static/1.42.2/21120102031201) + --keep-latest Only keep this number of latest packages uninstalling all others +``` + +**ARGS** + +``` + A package identifier (ex: core/redis, core/busybox-static/1.42.2) +``` + + + +--- + +### hab pkg upload + +Uploads a local Habitat Artifact to Builder + +**USAGE** + +``` +hab pkg upload [FLAGS] [OPTIONS] ... +``` + +**FLAGS** + +``` +--force Skips checking availability of package and force uploads, potentially overwriting a stored copy of a package. (default: false) + --no-build Disable auto-build for all packages in this upload +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-z, --auth Authentication token for Builder +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) + --cache-key-path Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=] [default: /hab/cache/keys] +-c, --channel Optional additional release channel to upload package to. Packages are always uploaded to unstable, regardless of the value of this option +``` + +**ARGS** + +``` +... One or more filepaths to a Habitat Artifact (ex: /home/acme-redis-3.0.7-21120102031201-x86_64- linux.hart) +``` + + + +--- + +### hab pkg verify + +Verifies a Habitat Artifact with an origin key + +**USAGE** + +``` +hab pkg verify [OPTIONS] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +--cache-key-path Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=] [default: /hab/cache/keys] +``` + +**ARGS** + +``` + A path to a Habitat Artifact (ex: /home/acme-redis-3.0.7-21120102031201-x86_64-linux.hart) +``` + + + +--- + +## hab plan + +Commands relating to plans and other app-specific configuration + +**USAGE** + +``` +hab plan +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + + + + +**SUBCOMMANDS** + +| Command | Description | +| ------- | ----------- | +| [hab plan init](#hab-plan-init) | Generates common package specific configuration files. Executing without argument will create a habitat directory in your current folder for the plan. If PKG_NAME is specified it will create a folder with that name. Environment variables (those starting with 'pkg_') that are set will be used in the generated plan | +| [hab plan render](#hab-plan-render) | Renders plan config files | +--- + +### hab plan init + +Generates common package specific configuration files. Executing without argument will create a habitat directory in + +**USAGE** + +``` +hab plan init [FLAGS] [OPTIONS] [PKG_NAME] +``` + +**FLAGS** + +``` +-m, --min Create a minimal plan file +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-o, --origin Origin for the new app +-s, --scaffolding Specify explicit Scaffolding for your app (ex: node, ruby) +``` + +**ARGS** + +``` + Name for the new app +``` + + + +--- + +### hab plan render + +Renders plan config files + +**USAGE** + +``` +hab plan render [FLAGS] [OPTIONS] +``` + +**FLAGS** + +``` +-n, --no-render Don't write anything to disk, ignores --render-dir +-p, --print Prints config to STDOUT +-q, --quiet Don't print any helper messages. When used with --print will only print config file +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-d, --default-toml Path to default.toml [default: ./default.toml] +-m, --mock-data Path to json file with mock data for template, defaults to none +-r, --render-dir Path to render templates [default: ./results] +-u, --user-toml Path to user.toml, defaults to none +``` + +**ARGS** + +``` + Path to config to render +``` + + + +--- + +## hab ring + +Commands relating to Habitat rings + +**USAGE** + +``` +hab ring +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + + + + +**SUBCOMMANDS** + +| Command | Description | +| ------- | ----------- | +| [hab ring key](#hab-ring-key) | Commands relating to Habitat ring keys | +--- + +### hab ring key + +Commands relating to Habitat ring keys + +**USAGE** + +``` +hab ring key +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + + + + +**SUBCOMMANDS** + +| Command | Description | +| ------- | ----------- | +| [hab ring key export](#hab-ring-key-export) | Outputs the latest ring key contents to stdout | +| [hab ring key generate](#hab-ring-key-generate) | Generates a Habitat ring key | +| [hab ring key import](#hab-ring-key-import) | Reads a stdin stream containing ring key contents and writes the key to disk | +--- + +### hab ring key export + +Outputs the latest ring key contents to stdout + +**USAGE** + +``` +hab ring key export [OPTIONS] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +--cache-key-path Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=] [default: /hab/cache/keys] +``` + +**ARGS** + +``` + Ring key name +``` + + + +--- + +### hab ring key generate + +Generates a Habitat ring key + +**USAGE** + +``` +hab ring key generate [OPTIONS] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +--cache-key-path Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=] [default: /hab/cache/keys] +``` + +**ARGS** + +``` + Ring key name +``` + + + +--- + +### hab ring key import + +Reads a stdin stream containing ring key contents and writes the key to disk + +**USAGE** + +``` +hab ring key import [OPTIONS] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +--cache-key-path Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=] [default: /hab/cache/keys] +``` + + + + +--- + +## hab studio + + + +**USAGE** + +``` +hab studio [FLAGS] [OPTIONS] [ARG ..] +``` + + + + + +**SUBCOMMANDS** + +| Command | Description | +| ------- | ----------- | +| [hab studio build](#hab-studio-build) | Build using a Studio | +| [hab studio enter](#hab-studio-enter) | Interactively enter a Studio | +| [hab studio new](#hab-studio-new) | Creates a new Studio | +| [hab studio rm](#hab-studio-rm) | Destroys a Studio | +| [hab studio run](#hab-studio-run) | Run a command in a Studio | +| [hab studio version](#hab-studio-version) | Prints version information | +--- + +### hab studio build + + + +**USAGE** + +``` +hab studio [COMMON_FLAGS] [COMMON_OPTIONS] build [FLAGS] [PLAN_DIR] +``` + +**FLAGS** + +``` +-R Reuse a previous Studio state (default: clean up before building) +``` + + + + + +--- + +### hab studio enter + + + +**USAGE** + +``` +hab studio [COMMON_FLAGS] [COMMON_OPTIONS] enter +``` + + + + + + +--- + +### hab studio new + + + +**USAGE** + +``` +hab studio [COMMON_FLAGS] [COMMON_OPTIONS] new +``` + + + + + + +--- + +### hab studio rm + + + +**USAGE** + +``` +hab studio [COMMON_FLAGS] [COMMON_OPTIONS] rm +``` + + + + + + +--- + +### hab studio run + + + +**USAGE** + +``` +hab studio [COMMON_FLAGS] [COMMON_OPTIONS] run [CMD] [ARG ..] +``` + + + + + + +--- + +### hab studio version + + + + + + + + + +--- + +## hab sup + + + +**USAGE** + +``` +hab sup +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + + + + +**SUBCOMMANDS** + +| Command | Description | +| ------- | ----------- | +| [hab sup bash](#hab-sup-bash) | Start an interactive Bash-like shell | +| [hab sup depart](#hab-sup-depart) | Depart a Supervisor from the gossip ring; kicking and banning the target from joining again with the same member-id | +| [hab sup restart](#hab-sup-restart) | Restart a Supervisor without restarting its services | +| [hab sup run](#hab-sup-run) | Run the Habitat Supervisor | +| [hab sup secret](#hab-sup-secret) | Commands relating to a Habitat Supervisor's Control Gateway secret | +| [hab sup sh](#hab-sup-sh) | Start an interactive Bourne-like shell | +| [hab sup status](#hab-sup-status) | Query the status of Habitat services | +| [hab sup term](#hab-sup-term) | Gracefully terminate the Habitat Supervisor and all of its running services | +--- + +### hab sup bash + +Start an interactive Bash-like shell + +**USAGE** + +``` +hab sup bash +``` + +**FLAGS** + +``` +-h, --help Prints help information +``` + + + + + +--- + +### hab sup depart + +Depart a Supervisor from the gossip ring; kicking and banning the target from joining again with the same member-id + +**USAGE** + +``` +hab sup depart [OPTIONS] +``` + +**FLAGS** + +``` +-h, --help Prints help information +``` + +**OPTIONS** + +``` +-r, --remote-sup Address to a remote Supervisor's Control Gateway [default: 127.0.0.1:9632] +``` + +**ARGS** + +``` + The member-id of the Supervisor to depart +``` + + + +--- + +### hab sup restart + +Restart a Supervisor without restarting its services + +**USAGE** + +``` +hab sup restart [OPTIONS] +``` + +**FLAGS** + +``` +-h, --help Prints help information +``` + +**OPTIONS** + +``` +-r, --remote-sup Address to a remote Supervisor's Control Gateway [default: 127.0.0.1:9632] +``` + + + + +--- + +### hab sup run + +Run the Habitat Supervisor + +**USAGE** + +``` +hab sup run [FLAGS] [OPTIONS] [--] [PKG_IDENT_OR_ARTIFACT] +``` + +**FLAGS** + +``` +-A, --auto-update Enable automatic updates for the Supervisor itself + --generate-config Generate a TOML config +-D, --http-disable Disable the HTTP Gateway completely + --json-logging Use structured JSON logging for the Supervisor + --local-gossip-mode Start the supervisor in local mode + --no-color Turn ANSI color off +-I, --permanent-peer Make this Supervisor a permanent peer +-v Verbose output showing file and line/column numbers +-h, --help Prints help information +``` + +**OPTIONS** + +``` +--auto-update-period The period of time in seconds between Supervisor update checks [default: 60] + + --bind ... One or more service groups to bind to a configuration + + --binding-mode Governs how the presence or absence of binds affects service startup [default: strict] [possible values: strict, relaxed] +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) + --cache-key-path Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=] [default: /hab/cache/keys] + + --ca-certs The CA certificate for HTTP Gateway TLS encryption + + --certs The server certificates for HTTP Gateway TLS encryption + + --channel Receive updates from the specified release channel [default: stable] + + --config-files ... Paths to config files to read + --config-from Use the package config from this path rather than the package itself + + --ctl-client-ca-certificate Enable client authentication for the control gateway and set the certificate authority to use when authenticating the client [default: /hab/cache/keys/ctl] + --ctl-server-certificate The control gateway server's TLS certificate [default: /hab/cache/keys/ctl] + + --ctl-server-key Enable TLS for the control gateway and set the server's private key [default: /hab/cache/keys/ctl] + + --event-meta ... An arbitrary key-value pair to add to each event generated by this Supervisor + + --event-stream-application The name of the application for event stream purposes + + --event-stream-connect-timeout Event stream connection timeout before exiting the Supervisor [env: HAB_EVENT_STREAM_CONNECT_TIMEOUT=] default: 0] + --event-stream-environment The name of the environment for event stream purposes + + --event-stream-server-certificate The path to Chef Automate's event stream certificate used to establish a TLS connection + + --event-stream-site The name of the site where this Supervisor is running for event stream purposes + + --event-stream-token The authentication token for connecting the event stream to Chef Automate [env: HAB_AUTOMATE_AUTH_TOKEN=] + + --event-stream-url The event stream connection url used to send events to Chef Automate + + --group The service group with shared config and topology [default: default] + +-i, --health-check-interval The interval in seconds on which to run health checks [default: 30] + + --keep-latest-packages Automatically cleanup old packages [env: HAB_KEEP_LATEST_PACKAGES=] + + --key The private key for HTTP Gateway TLS encryption + + --listen-ctl The listen address for the Control Gateway [env: HAB_LISTEN_CTL=] [default: 127.0.0.1:9632] + + --listen-gossip The listen address for the Gossip Gateway [env: HAB_LISTEN_GOSSIP=] [default: 0.0.0.0:9638] + + --listen-http The listen address for the HTTP Gateway [env: HAB_LISTEN_HTTP=] [default: 0.0.0.0:9631] + + --org The organization the Supervisor and its services are part of + + --peer ... The listen address of one or more initial peers (IP[:PORT]) + + --peer-watch-file Watch this file for connecting to the ring + +-r, --ring The name of the ring used by the Supervisor when running with wire encryption [env: HAB_RING=] + + --service-max-backoff-period The maximum period of time in seconds to wait before attempting to restart a service that failed to start up default: 0] + --service-min-backoff-period The minimum period of time in seconds to wait before attempting to restart a service that failed to start up default: 0] + --service-restart-cooldown-period The period of time in seconds to wait before assuming that a service started up successfully after a restart default: 300] + --service-update-period The period of time in seconds between service update checks [default: 60] + + --shutdown-timeout The delay in seconds after sending the shutdown signal to wait before killing the service process + +-s, --strategy The update strategy [default: none] [possible values: none, at-once, rolling] + + --sys-ip-address The IPv4 address to use as the sys.ip template variable + +-t, --topology Service topology [possible values: standalone, leader] + + --update-condition The condition dictating when this service should update [default: latest] [possible values: latest, track- channel] +``` + +**ARGS** + +``` + Load a Habitat package as part of the Supervisor startup +``` + + + +--- + +### hab sup secret + +Commands relating to a Habitat Supervisor's Control Gateway secret + +**USAGE** + +``` +hab sup secret +``` + +**FLAGS** + +``` +-h, --help Prints help information +``` + + + + +**SUBCOMMANDS** + +| Command | Description | +| ------- | ----------- | +| [hab sup secret generate](#hab-sup-secret-generate) | Generate a secret key to use as a Supervisor's Control Gateway secret | +| [hab sup secret generate-tls](#hab-sup-secret-generate-tls) | Generate a private key and certificate for the Supervisor's Control Gateway TLS connection | +--- + +### hab sup secret generate + +Generate a secret key to use as a Supervisor's Control Gateway secret + +**USAGE** + +``` +hab sup secret generate +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + + + + + +--- + +### hab sup secret generate-tls + +Generate a private key and certificate for the Supervisor's Control Gateway TLS connection + +**USAGE** + +``` +hab sup secret generate-tls [OPTIONS] --subject-alternative-name +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +--path The directory to store the generated private key and certificate [default: /hab/cache/keys/ctl] + + --subject-alternative-name The DNS name to use in the certificates subject alternative name extension +``` + + + + +--- + +### hab sup sh + +Start an interactive Bourne-like shell + +**USAGE** + +``` +hab sup sh +``` + +**FLAGS** + +``` +-h, --help Prints help information +``` + + + + + +--- + +### hab sup status + +Query the status of Habitat services + +**USAGE** + +``` +hab sup status [OPTIONS] [PKG_IDENT] +``` + +**FLAGS** + +``` +-h, --help Prints help information +``` + +**OPTIONS** + +``` +-r, --remote-sup Address to a remote Supervisor's Control Gateway [default: 127.0.0.1:9632] +``` + +**ARGS** + +``` + A package identifier (ex: core/redis, core/busybox-static/1.42.2) +``` + + + +--- + +### hab sup term + +Gracefully terminate the Habitat Supervisor and all of its running services + +**USAGE** + +``` +hab sup term +``` + +**FLAGS** + +``` +-h, --help Prints help information +``` + + + + + +--- + +## hab supportbundle + +Create a tarball of Habitat Supervisor data to send to support + +**USAGE** + +``` +hab supportbundle +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + + + + + +--- + +## hab svc + +Commands relating to Habitat services + +**USAGE** + +``` +hab svc +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + + + + +**SUBCOMMANDS** + +| Command | Description | +| ------- | ----------- | +| [hab svc key](#hab-svc-key) | Commands relating to Habitat service keys | +| [hab svc load](#hab-svc-load) | Load a service to be started and supervised by Habitat from a package identifier. If an installed package doesn't satisfy the given package identifier, a suitable package will be installed from Builder | +| [hab svc start](#hab-svc-start) | Start a loaded, but stopped, Habitat service | +| [hab svc status](#hab-svc-status) | Query the status of Habitat services | +| [hab svc stop](#hab-svc-stop) | Stop a running Habitat service | +| [hab svc unload](#hab-svc-unload) | Unload a service loaded by the Habitat Supervisor. If the service is running it will additionally be stopped | +| [hab svc update](#hab-svc-update) | Update how the Supervisor manages an already-running service. Depending on the given changes, they may be able to be applied without restarting the service | +--- + +### hab svc key + +Commands relating to Habitat service keys + +**USAGE** + +``` +hab svc key +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + + + + +**SUBCOMMANDS** + +| Command | Description | +| ------- | ----------- | +| [hab svc key generate](#hab-svc-key-generate) | Generates a Habitat service key | +--- + +### hab svc key generate + +Generates a Habitat service key + +**USAGE** + +``` +hab svc key generate [OPTIONS] [ORG] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +--cache-key-path Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=] [default: /hab/cache/keys] +``` + +**ARGS** + +``` + Target service group service.group[@organization] (ex: redis.default or foo.default@bazcorp) + The service organization +``` + + + +--- + +### hab svc load + +Load a service to be started and supervised by Habitat from a package identifier. If an installed package doesn't + +**USAGE** + +``` +hab svc load [FLAGS] [OPTIONS] +``` + +**FLAGS** + +``` +-f, --force Load or reload an already loaded service. If the service was previously loaded and running this operation will also restart the service +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +--bind ... One or more service groups to bind to a configuration + --binding-mode Governs how the presence or absence of binds affects service startup [default: strict] [possible values: strict, relaxed] +-u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) + --channel Receive updates from the specified release channel [default: stable] + + --config-from Use the package config from this path rather than the package itself + + --group The service group with shared config and topology [default: default] + +-i, --health-check-interval The interval in seconds on which to run health checks [default: 30] + +-r, --remote-sup Address to a remote Supervisor's Control Gateway [default: 127.0.0.1:9632] + + --shutdown-timeout The delay in seconds after sending the shutdown signal to wait before killing the service process + +-s, --strategy The update strategy [default: none] [possible values: none, at-once, rolling] + +-t, --topology Service topology [possible values: standalone, leader] + --update-condition The condition dictating when this service should update [default: latest] [possible values: latest, track- channel] +``` + +**ARGS** + +``` + A package identifier (ex: core/redis, core/busybox-static/1.42.2) +``` + + + +--- + +### hab svc start + +Start a loaded, but stopped, Habitat service + +**USAGE** + +``` +hab svc start [OPTIONS] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-r, --remote-sup Address to a remote Supervisor's Control Gateway [default: 127.0.0.1:9632] +``` + +**ARGS** + +``` + A package identifier (ex: core/redis, core/busybox-static/1.42.2) +``` + + + +--- + +### hab svc status + +Query the status of Habitat services + +**USAGE** + +``` +hab svc status [OPTIONS] [PKG_IDENT] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-r, --remote-sup Address to a remote Supervisor's Control Gateway [default: 127.0.0.1:9632] +``` + +**ARGS** + +``` + A package identifier (ex: core/redis, core/busybox-static/1.42.2) +``` + + + +--- + +### hab svc stop + +Stop a running Habitat service + +**USAGE** + +``` +hab svc stop [OPTIONS] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-r, --remote-sup Address to a remote Supervisor's Control Gateway [default: 127.0.0.1:9632] + + --shutdown-timeout The delay in seconds after sending the shutdown signal to wait before killing the service process +``` + +**ARGS** + +``` + A package identifier (ex: core/redis, core/busybox-static/1.42.2) +``` + + + +--- + +### hab svc unload + +Unload a service loaded by the Habitat Supervisor. If the service is running it will additionally be stopped + +**USAGE** + +``` +hab svc unload [OPTIONS] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +-r, --remote-sup Address to a remote Supervisor's Control Gateway [default: 127.0.0.1:9632] + + --shutdown-timeout The delay in seconds after sending the shutdown signal to wait before killing the service process +``` + +**ARGS** + +``` + A package identifier (ex: core/redis, core/busybox-static/1.42.2) +``` + + + +--- + +### hab svc update + +Update how the Supervisor manages an already-running service. Depending on the given changes, they may be able to be + +**USAGE** + +``` +hab svc update [OPTIONS] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +--bind ... One or more service groups to bind to a configuration + --binding-mode Governs how the presence or absence of binds affects service startup [possible values: strict, relaxed] + +-u, --url Specify an alternate Builder endpoint + --channel Receive updates from the specified release channel + --group The service group with shared config and topology +-i, --health-check-interval The interval in seconds on which to run health checks +-r, --remote-sup Address to a remote Supervisor's Control Gateway [default: 127.0.0.1:9632] + + --shutdown-timeout The delay in seconds after sending the shutdown signal to wait before killing the service process + +-s, --strategy The update strategy [possible values: none, at-once, rolling] +-t, --topology Service topology [possible values: standalone, leader] + --update-condition The condition dictating when this service should update [possible values: latest, track-channel] +``` + +**ARGS** + +``` + A package identifier (ex: core/redis, core/busybox-static/1.42.2) +``` + + + +--- + +## hab user + +Commands relating to Habitat users + +**USAGE** + +``` +hab user +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + + + + +**SUBCOMMANDS** + +| Command | Description | +| ------- | ----------- | +| [hab user key](#hab-user-key) | Commands relating to Habitat user keys | +--- + +### hab user key + +Commands relating to Habitat user keys + +**USAGE** + +``` +hab user key +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + + + + +**SUBCOMMANDS** + +| Command | Description | +| ------- | ----------- | +| [hab user key generate](#hab-user-key-generate) | Generates a Habitat user key | +--- + +### hab user key generate + +Generates a Habitat user key + +**USAGE** + +``` +hab user key generate [OPTIONS] +``` + +**FLAGS** + +``` +-h, --help Prints help information +-V, --version Prints version information +``` + +**OPTIONS** + +``` +--cache-key-path Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=] [default: /hab/cache/keys] +``` + +**ARGS** + +``` + Name of the user key +``` + + + +--- + diff --git a/content/habitat/habitat_cli.md b/content/habitat/habitat_cli.md index d531bd6bc1..5d0c739866 100644 --- a/content/habitat/habitat_cli.md +++ b/content/habitat/habitat_cli.md @@ -1,3777 +1,7 @@ +++ title = "Chef Habitat Command-Line Interface (CLI) Reference" draft= false - -[menu] - [menu.habitat] - title = "Habitat CLI Reference" - identifier = "habitat/reference/Habitat CLI Reference" - parent = "habitat/reference" - weight = 10 +layout="redirect" +redirect_url="https://docs.chef.io/habitat/cli/" +# Redirect layout for existing links to CLI page. +++ - - - - - -The commands for the Chef Habitat CLI (`hab`) are listed below. - -| Applies to Version | Last Updated | -| ------- | ------------ | -| hab 1.6.652/20230206155653 (linux) | 6 Feb 2023 | - -## hab - - - -**USAGE** - -``` -hab -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - - - -**ALIASES** - -``` -apply Alias for: 'config apply' -install Alias for: 'pkg install' -run Alias for: 'sup run' -setup Alias for: 'cli setup' -start Alias for: 'svc start' -stop Alias for: 'svc stop' -term Alias for: 'sup term' -``` - -**SUBCOMMANDS** - -| Command | Description | -| ------- | ----------- | -| [hab bldr](#hab-bldr) | Commands relating to Habitat Builder | -| [hab cli](#hab-cli) | Commands relating to Habitat runtime config | -| [hab config](#hab-config) | Commands relating to a Service's runtime config | -| [hab file](#hab-file) | Commands relating to Habitat files | -| [hab license](#hab-license) | Commands relating to Habitat license agreements | -| [hab origin](#hab-origin) | Commands relating to Habitat Builder origins | -| [hab pkg](#hab-pkg) | Commands relating to Habitat packages | -| [hab plan](#hab-plan) | Commands relating to plans and other app-specific configuration | -| [hab ring](#hab-ring) | Commands relating to Habitat rings | -| [hab studio](#hab-studio) | Commands relating to Habitat Studios | -| [hab sup](#hab-sup) | The Habitat Supervisor | -| [hab supportbundle](#hab-supportbundle) | Create a tarball of Habitat Supervisor data to send to support | -| [hab svc](#hab-svc) | Commands relating to Habitat services | -| [hab user](#hab-user) | Commands relating to Habitat users | ---- - -## hab bldr - -Commands relating to Habitat Builder - -**USAGE** - -``` -hab bldr -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - - - - -**SUBCOMMANDS** - -| Command | Description | -| ------- | ----------- | -| [hab bldr channel](#hab-bldr-channel) | Commands relating to Habitat Builder channels | -| [hab bldr job](#hab-bldr-job) | Commands relating to Habitat Builder jobs | ---- - -### hab bldr channel - -Commands relating to Habitat Builder channels - -**USAGE** - -``` -hab bldr channel -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - - - - -**SUBCOMMANDS** - -| Command | Description | -| ------- | ----------- | -| [hab bldr channel create](#hab-bldr-channel-create) | Creates a new channel | -| [hab bldr channel demote](#hab-bldr-channel-demote) | Atomically demotes selected packages in a target channel | -| [hab bldr channel destroy](#hab-bldr-channel-destroy) | Destroys a channel | -| [hab bldr channel list](#hab-bldr-channel-list) | Lists origin channels | -| [hab bldr channel promote](#hab-bldr-channel-promote) | Atomically promotes all packages in channel | ---- - -### hab bldr channel create - -Creates a new channel - -**USAGE** - -``` -hab bldr channel create [OPTIONS] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) --o, --origin Sets the origin to which the channel will belong. Default is from 'HAB_ORIGIN' or cli.toml -``` - -**ARGS** - -``` - The channel name -``` - - - ---- - -### hab bldr channel demote - -Atomically demotes selected packages in a target channel - -**USAGE** - -``` -hab bldr channel demote [OPTIONS] --origin -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --z, --auth Authentication token for Builder --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) --o, --origin The origin for the channels. Default is from 'HAB_ORIGIN' or cli.toml -``` - -**ARGS** - -``` - The channel from which all packages will be selected for demotion - The channel selected packages will be removed from -``` - - - ---- - -### hab bldr channel destroy - -Destroys a channel - -**USAGE** - -``` -hab bldr channel destroy [OPTIONS] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) --o, --origin Sets the origin to which the channel belongs. Default is from 'HAB_ORIGIN' or cli.toml -``` - -**ARGS** - -``` - The channel name -``` - - - ---- - -### hab bldr channel list - -Lists origin channels - -**USAGE** - -``` -hab bldr channel list [FLAGS] [OPTIONS] [ORIGIN] -``` - -**FLAGS** - -``` --s, --sandbox Include sandbox channels for the origin --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) -``` - -**ARGS** - -``` - The origin for which channels will be listed. Default is from 'HAB_ORIGIN' or cli.toml -``` - - - ---- - -### hab bldr channel promote - -Atomically promotes all packages in channel - -**USAGE** - -``` -hab bldr channel promote [OPTIONS] --origin -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --z, --auth Authentication token for Builder --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) --o, --origin The origin for the channels. Default is from 'HAB_ORIGIN' or cli.toml -``` - -**ARGS** - -``` - The channel from which all packages will be selected for promotion - The channel to which packages will be promoted -``` - - - ---- - -### hab bldr job - -Commands relating to Habitat Builder jobs - -**USAGE** - -``` -hab bldr job -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - - - - -**SUBCOMMANDS** - -| Command | Description | -| ------- | ----------- | -| [hab bldr job cancel](#hab-bldr-job-cancel) | Cancel a build job group and any in-progress builds | -| [hab bldr job demote](#hab-bldr-job-demote) | Demote packages from a completed build job from a specified channel | -| [hab bldr job promote](#hab-bldr-job-promote) | Promote packages from a completed build job to a specified channel | -| [hab bldr job start](#hab-bldr-job-start) | Schedule a build job or group of jobs | -| [hab bldr job status](#hab-bldr-job-status) | Get the status of one or more job groups | ---- - -### hab bldr job cancel - -Cancel a build job group and any in-progress builds - -**USAGE** - -``` -hab bldr job cancel [FLAGS] [OPTIONS] -``` - -**FLAGS** - -``` --f, --force Don't prompt for confirmation --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --z, --auth Authentication token for Builder --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) -``` - -**ARGS** - -``` - The job group id that was returned from "hab bldr job start" (ex: 771100000000000000) -``` - - - ---- - -### hab bldr job demote - -Demote packages from a completed build job from a specified channel - -**USAGE** - -``` -hab bldr job demote [FLAGS] [OPTIONS] -``` - -**FLAGS** - -``` --i, --interactive Allow editing the list of demotable packages --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --z, --auth Authentication token for Builder --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) --o, --origin Limit the demotable packages to the specified origin -``` - -**ARGS** - -``` - The job group id that was returned from "hab bldr job start" (ex: 771100000000000000) - The name of the channel to demote from -``` - - - ---- - -### hab bldr job promote - -Promote packages from a completed build job to a specified channel - -**USAGE** - -``` -hab bldr job promote [FLAGS] [OPTIONS] -``` - -**FLAGS** - -``` --i, --interactive Allow editing the list of promotable packages --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --z, --auth Authentication token for Builder --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) --o, --origin Limit the promotable packages to the specified origin -``` - -**ARGS** - -``` - The job group id that was returned from "hab bldr job start" (ex: 771100000000000000) - The target channel name -``` - - - ---- - -### hab bldr job start - -Schedule a build job or group of jobs - -**USAGE** - -``` -hab bldr job start [FLAGS] [OPTIONS] [PKG_TARGET] -``` - -**FLAGS** - -``` --g, --group Schedule jobs for this package and all of its reverse dependencies --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --z, --auth Authentication token for Builder --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) -``` - -**ARGS** - -``` - A package identifier (ex: core/redis, core/busybox-static/1.42.2) - A package target (ex: x86_64-windows) (default: system appropriate target) [env: HAB_PACKAGE_TARGET=] -``` - - - ---- - -### hab bldr job status - -Get the status of one or more job groups - -**USAGE** - -``` -hab bldr job status [FLAGS] [OPTIONS] > -``` - -**FLAGS** - -``` --s, --showjobs Show the status of all build jobs for a retrieved job group --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) --l, --limit Limit how many job groups to retrieve, ordered by most recent (default: 10) --o, --origin Show the status of recent job groups created in this origin (default: 10 most recent) -``` - -**ARGS** - -``` - The job group id that was returned from "hab bldr job start" (ex: 771100000000000000) -``` - - - ---- - -## hab cli - -Commands relating to Habitat runtime config - -**USAGE** - -``` -hab cli -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - - - - -**SUBCOMMANDS** - -| Command | Description | -| ------- | ----------- | -| [hab cli completers](#hab-cli-completers) | Creates command-line completers for your shell | -| [hab cli setup](#hab-cli-setup) | Sets up the CLI with reasonable defaults | ---- - -### hab cli completers - -Creates command-line completers for your shell - -**USAGE** - -``` -hab cli completers --shell -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --s, --shell The name of the shell you want to generate the command-completion [possible values: Bash, Fish, Zsh, PowerShell] -``` - - - - ---- - -### hab cli setup - -Sets up the CLI with reasonable defaults - -**USAGE** - -``` -hab cli setup [OPTIONS] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` ---cache-key-path Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=] [default: /hab/cache/keys] -``` - - - - ---- - -## hab config - -Commands relating to a Service's runtime config - -**USAGE** - -``` -hab config -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - - - - -**SUBCOMMANDS** - -| Command | Description | -| ------- | ----------- | -| [hab config apply](#hab-config-apply) | Sets a configuration to be shared by members of a Service Group | -| [hab config show](#hab-config-show) | Displays the default configuration options for a service | ---- - -### hab config apply - -Sets a configuration to be shared by members of a Service Group - -**USAGE** - -``` -hab config apply [OPTIONS] [FILE] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` ---cache-key-path Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=] [default: /hab/cache/keys] --r, --remote-sup Address to a remote Supervisor's Control Gateway [default: 127.0.0.1:9632] --u, --user Name of a user key to use for encryption -``` - -**ARGS** - -``` - Target service group service.group[@organization] (ex: redis.default or foo.default@bazcorp) - A version number (positive integer) for this configuration (ex: 42) - Path to local file on disk (ex: /tmp/config.toml, default: ) -``` - - - ---- - -### hab config show - -Displays the default configuration options for a service - -**USAGE** - -``` -hab config show [OPTIONS] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --r, --remote-sup Address to a remote Supervisor's Control Gateway [default: 127.0.0.1:9632] -``` - -**ARGS** - -``` - A package identifier (ex: core/redis, core/busybox-static/1.42.2) -``` - - - ---- - -## hab file - -Commands relating to Habitat files - -**USAGE** - -``` -hab file -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - - - - -**SUBCOMMANDS** - -| Command | Description | -| ------- | ----------- | -| [hab file upload](#hab-file-upload) | Uploads a file to be shared between members of a Service Group | ---- - -### hab file upload - -Uploads a file to be shared between members of a Service Group - -**USAGE** - -``` -hab file upload [OPTIONS] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` ---cache-key-path Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=] [default: /hab/cache/keys] --r, --remote-sup Address to a remote Supervisor's Control Gateway [default: 127.0.0.1:9632] --u, --user Name of the user key -``` - -**ARGS** - -``` - Target service group service.group[@organization] (ex: redis.default or foo.default@bazcorp) - A version number (positive integer) for this configuration (ex: 42) - Path to local file on disk -``` - - - ---- - -## hab license - -Commands relating to Habitat license agreements - -**USAGE** - -``` -hab license -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - - - - -**SUBCOMMANDS** - -| Command | Description | -| ------- | ----------- | -| [hab license accept](#hab-license-accept) | Accept the Chef Binary Distribution Agreement without prompting | ---- - -### hab license accept - -Accept the Chef Binary Distribution Agreement without prompting - -**USAGE** - -``` -hab license accept -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - - - - - ---- - -## hab origin - -Commands relating to Habitat Builder origins - -**USAGE** - -``` -hab origin -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - - - - -**SUBCOMMANDS** - -| Command | Description | -| ------- | ----------- | -| [hab origin create](#hab-origin-create) | Creates a new Builder origin | -| [hab origin delete](#hab-origin-delete) | Removes an unused/empty origin | -| [hab origin depart](#hab-origin-depart) | Departs membership from selected origin | -| [hab origin info](#hab-origin-info) | Displays general information about an origin | -| [hab origin invitations](#hab-origin-invitations) | Manage origin member invitations | -| [hab origin key](#hab-origin-key) | Commands relating to Habitat origin key maintenance | -| [hab origin rbac](#hab-origin-rbac) | Role Based Access Control for origin members | -| [hab origin secret](#hab-origin-secret) | Commands related to secret management | -| [hab origin transfer](#hab-origin-transfer) | Transfers ownership of an origin to another member of that origin | ---- - -### hab origin create - -Creates a new Builder origin - -**USAGE** - -``` -hab origin create [OPTIONS] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --z, --auth Authentication token for Builder --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) -``` - -**ARGS** - -``` - The origin to be created -``` - - - ---- - -### hab origin delete - -Removes an unused/empty origin - -**USAGE** - -``` -hab origin delete [OPTIONS] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --z, --auth Authentication token for Builder --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) -``` - -**ARGS** - -``` - The origin name -``` - - - ---- - -### hab origin depart - -Departs membership from selected origin - -**USAGE** - -``` -hab origin depart [OPTIONS] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --z, --auth Authentication token for Builder --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) -``` - -**ARGS** - -``` - The origin name -``` - - - ---- - -### hab origin info - -Displays general information about an origin - -**USAGE** - -``` -hab origin info [FLAGS] [OPTIONS] -``` - -**FLAGS** - -``` --j, --json Output will be rendered in json --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --z, --auth Authentication token for Builder --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) -``` - -**ARGS** - -``` - The origin name to be queried -``` - - - ---- - -### hab origin invitations - -Manage origin member invitations - -**USAGE** - -``` -hab origin invitations -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - - - - -**SUBCOMMANDS** - -| Command | Description | -| ------- | ----------- | -| [hab origin invitations accept](#hab-origin-invitations-accept) | Accept an origin member invitation | -| [hab origin invitations ignore](#hab-origin-invitations-ignore) | Ignore an origin member invitation | -| [hab origin invitations list](#hab-origin-invitations-list) | List origin invitations sent to your account | -| [hab origin invitations pending](#hab-origin-invitations-pending) | List pending invitations for a particular origin. Requires that you are the origin owner | -| [hab origin invitations rescind](#hab-origin-invitations-rescind) | Rescind an existing origin member invitation | -| [hab origin invitations send](#hab-origin-invitations-send) | Send an origin member invitation | ---- - -### hab origin invitations accept - -Accept an origin member invitation - -**USAGE** - -``` -hab origin invitations accept [OPTIONS] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --z, --auth Authentication token for Builder --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) -``` - -**ARGS** - -``` - The origin name the invitation applies to - The id of the invitation to accept -``` - - - ---- - -### hab origin invitations ignore - -Ignore an origin member invitation - -**USAGE** - -``` -hab origin invitations ignore [OPTIONS] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --z, --auth Authentication token for Builder --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) -``` - -**ARGS** - -``` - The origin name the invitation applies to - The id of the invitation to ignore -``` - - - ---- - -### hab origin invitations list - -List origin invitations sent to your account - -**USAGE** - -``` -hab origin invitations list [OPTIONS] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --z, --auth Authentication token for Builder --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) -``` - - - - ---- - -### hab origin invitations pending - -List pending invitations for a particular origin. Requires that you are the origin owner - -**USAGE** - -``` -hab origin invitations pending [OPTIONS] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --z, --auth Authentication token for Builder --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) -``` - -**ARGS** - -``` - The name of the origin you wish to list invitations for -``` - - - ---- - -### hab origin invitations rescind - -Rescind an existing origin member invitation - -**USAGE** - -``` -hab origin invitations rescind [OPTIONS] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --z, --auth Authentication token for Builder --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) -``` - -**ARGS** - -``` - The origin name the invitation applies to - The id of the invitation to rescind -``` - - - ---- - -### hab origin invitations send - -Send an origin member invitation - -**USAGE** - -``` -hab origin invitations send [OPTIONS] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --z, --auth Authentication token for Builder --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) -``` - -**ARGS** - -``` - The origin name the invitation applies to - The account name to invite into the origin -``` - - - ---- - -### hab origin key - -Commands relating to Habitat origin key maintenance - -**USAGE** - -``` -hab origin key -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - - - - -**SUBCOMMANDS** - -| Command | Description | -| ------- | ----------- | -| [hab origin key download](#hab-origin-key-download) | Download origin key(s) | -| [hab origin key export](#hab-origin-key-export) | Outputs the latest origin key contents to stdout | -| [hab origin key generate](#hab-origin-key-generate) | Generates a Habitat origin key pair | -| [hab origin key import](#hab-origin-key-import) | Reads a stdin stream containing a public or private origin key contents and writes the key to disk | -| [hab origin key upload](#hab-origin-key-upload) | Upload origin keys to Builder | ---- - -### hab origin key download - -Download origin key(s) - -**USAGE** - -``` -hab origin key download [FLAGS] [OPTIONS] [REVISION] -``` - -**FLAGS** - -``` --e, --encryption Download public encryption key instead of origin public key --s, --secret Download origin private key instead of origin public key --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --z, --auth Authentication token for Builder (required for downloading origin private keys) --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) - --cache-key-path Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=] [default: /hab/cache/keys] -``` - -**ARGS** - -``` - The origin name - The origin key revision -``` - - - ---- - -### hab origin key export - -Outputs the latest origin key contents to stdout - -**USAGE** - -``` -hab origin key export [OPTIONS] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` ---cache-key-path Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=] [default: /hab/cache/keys] --t, --type Export either the 'public' or 'secret' key. The 'secret' key is the origin private key -``` - -**ARGS** - -``` - The origin name -``` - - - ---- - -### hab origin key generate - -Generates a Habitat origin key pair - -**USAGE** - -``` -hab origin key generate [OPTIONS] [ORIGIN] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` ---cache-key-path Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=] [default: /hab/cache/keys] -``` - -**ARGS** - -``` - The origin name -``` - - - ---- - -### hab origin key import - -Reads a stdin stream containing a public or private origin key contents and writes the key to disk - -**USAGE** - -``` -hab origin key import [OPTIONS] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` ---cache-key-path Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=] [default: /hab/cache/keys] -``` - - - - ---- - -### hab origin key upload - -Upload origin keys to Builder - -**USAGE** - -``` -hab origin key upload [FLAGS] [OPTIONS] > -``` - -**FLAGS** - -``` --s, --secret Upload origin private key in addition to the public key --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --z, --auth Authentication token for Builder --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) - --cache-key-path Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=] [default: /hab/cache/keys] - --pubfile Path to a local public origin key file on disk - --secfile Path to a local origin private key file on disk -``` - -**ARGS** - -``` - The origin name -``` - - - ---- - -### hab origin rbac - -Role Based Access Control for origin members - -**USAGE** - -``` -hab origin rbac -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - - - - -**SUBCOMMANDS** - -| Command | Description | -| ------- | ----------- | -| [hab origin rbac set](#hab-origin-rbac-set) | Change an origin member's role | -| [hab origin rbac show](#hab-origin-rbac-show) | Display an origin member's current role | ---- - -### hab origin rbac set - -Change an origin member's role - -**USAGE** - -``` -hab origin rbac set [FLAGS] [OPTIONS] --origin -``` - -**FLAGS** - -``` --n, --no-prompt Do not prompt for confirmation --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --z, --auth Authentication token for Builder --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) --o, --origin The Builder origin name to target -``` - -**ARGS** - -``` - The account name whose role will be changed - The role name to enforce for the member account [possible values: readonly_member, member, maintainer, administrator, owner] -``` - - - ---- - -### hab origin rbac show - -Display an origin member's current role - -**USAGE** - -``` -hab origin rbac show [FLAGS] [OPTIONS] --origin -``` - -**FLAGS** - -``` --j, --json Output will be rendered in json --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --z, --auth Authentication token for Builder --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) --o, --origin The Builder origin name to target -``` - -**ARGS** - -``` - The account name of the role to display -``` - - - ---- - -### hab origin secret - -Commands related to secret management - -**USAGE** - -``` -hab origin secret -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - - - - -**SUBCOMMANDS** - -| Command | Description | -| ------- | ----------- | -| [hab origin secret delete](#hab-origin-secret-delete) | Delete a secret for your origin | -| [hab origin secret list](#hab-origin-secret-list) | List all secrets for your origin | -| [hab origin secret upload](#hab-origin-secret-upload) | Create and upload a secret for your origin | ---- - -### hab origin secret delete - -Delete a secret for your origin - -**USAGE** - -``` -hab origin secret delete [OPTIONS] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --z, --auth Authentication token for Builder --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) --o, --origin The origin for which the secret will be deleted. Default is from 'HAB_ORIGIN' or cli.toml -``` - -**ARGS** - -``` - The name of the variable key to be injected into the studio -``` - - - ---- - -### hab origin secret list - -List all secrets for your origin - -**USAGE** - -``` -hab origin secret list [OPTIONS] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --z, --auth Authentication token for Builder --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) --o, --origin The origin for which secrets will be listed. Default is from 'HAB_ORIGIN' or cli.toml -``` - - - - ---- - -### hab origin secret upload - -Create and upload a secret for your origin - -**USAGE** - -``` -hab origin secret upload [OPTIONS] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --z, --auth Authentication token for Builder --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) - --cache-key-path Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=] [default: /hab/cache/keys] --o, --origin The origin for which the secret will be uploaded. Default is from HAB_ORIGIN' or cli.toml -``` - -**ARGS** - -``` - The name of the variable key to be injected into the studio. Ex: KEY="some_value" - The contents of the variable to be injected into the studio -``` - - - ---- - -### hab origin transfer - -Transfers ownership of an origin to another member of that origin - -**USAGE** - -``` -hab origin transfer [OPTIONS] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --z, --auth Authentication token for Builder --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) -``` - -**ARGS** - -``` - The origin name - The account name of the new origin owner -``` - - - ---- - -## hab pkg - -Commands relating to Habitat packages - -**USAGE** - -``` -hab pkg -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - - - - -**SUBCOMMANDS** - -| Command | Description | -| ------- | ----------- | -| [hab pkg binds](#hab-pkg-binds) | Displays the binds for a service | -| [hab pkg binlink](#hab-pkg-binlink) | Creates a binlink for a package binary in a common 'PATH' location | -| [hab pkg build](#hab-pkg-build) | Builds a Plan using a Studio | -| [hab pkg bulkupload](#hab-pkg-bulkupload) | Bulk Uploads Habitat Artifacts to a Depot from a local directory | -| [hab pkg channels](#hab-pkg-channels) | Find out what channels a package belongs to | -| [hab pkg config](#hab-pkg-config) | Displays the default configuration options for a service | -| [hab pkg delete](#hab-pkg-delete) | Removes a package from Builder | -| [hab pkg demote](#hab-pkg-demote) | Demote a package from a specified channel | -| [hab pkg dependencies](#hab-pkg-dependencies) | Returns the Habitat Artifact dependencies. By default it will return the direct dependencies of the package | -| [hab pkg download](#hab-pkg-download) | Download Habitat artifacts (including dependencies and keys) from Builder | -| [hab pkg env](#hab-pkg-env) | Prints the runtime environment of a specific installed package | -| [hab pkg exec](#hab-pkg-exec) | Executes a command using the 'PATH' context of an installed package | -| [hab pkg export](#hab-pkg-export) | Exports the package to the specified format | -| [hab pkg hash](#hab-pkg-hash) | Generates a blake2b hashsum from a target at any given filepath | -| [hab pkg info](#hab-pkg-info) | Returns the Habitat Artifact information | -| [hab pkg install](#hab-pkg-install) | Installs a Habitat package from Builder or locally from a Habitat Artifact | -| [hab pkg list](#hab-pkg-list) | List all versions of installed packages | -| [hab pkg path](#hab-pkg-path) | Prints the path to a specific installed release of a package | -| [hab pkg promote](#hab-pkg-promote) | Promote a package to a specified channel | -| [hab pkg provides](#hab-pkg-provides) | Search installed Habitat packages for a given file | -| [hab pkg search](#hab-pkg-search) | Search for a package in Builder | -| [hab pkg sign](#hab-pkg-sign) | Signs an archive with an origin key, generating a Habitat Artifact | -| [hab pkg uninstall](#hab-pkg-uninstall) | Safely uninstall a package and dependencies from the local filesystem | -| [hab pkg upload](#hab-pkg-upload) | Uploads a local Habitat Artifact to Builder | -| [hab pkg verify](#hab-pkg-verify) | Verifies a Habitat Artifact with an origin key | ---- - -### hab pkg binds - -Displays the binds for a service - -**USAGE** - -``` -hab pkg binds -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - - -**ARGS** - -``` - A package identifier (ex: core/redis, core/busybox-static/1.42.2) -``` - - - ---- - -### hab pkg binlink - -Creates a binlink for a package binary in a common 'PATH' location - -**USAGE** - -``` -hab pkg binlink [FLAGS] [OPTIONS] [BINARY] -``` - -**FLAGS** - -``` --f, --force Overwrite existing binlinks --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --d, --dest Sets the destination directory [env: HAB_BINLINK_DIR=] [default: /bin] -``` - -**ARGS** - -``` - A package identifier (ex: core/redis, core/busybox-static/1.42.2) - The command to binlink (ex: bash) -``` - - - ---- - -### hab pkg build - -Builds a Plan using a Studio - -**USAGE** - -``` -hab pkg build [FLAGS] [OPTIONS] -``` - -**FLAGS** - -``` --D, --docker Uses a Dockerized Studio for the build --N, --native-package Build a native package on the host system without a studio --R, --reuse Reuses a previous Studio for the build (default: clean up before building) --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` ---cache-key-path Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=] [default: /hab/cache/keys] --k, --keys Installs secret origin keys (ex: "unicorn", "acme,other,acme-ops") --r, --root Sets the Studio root (default: /hab/studios/) --s, --src Sets the source path (default: $PWD) -``` - -**ARGS** - -``` - A directory containing a plan file or a habitat/ directory which contains the plan file -``` - - - ---- - -### hab pkg bulkupload - -Bulk Uploads Habitat Artifacts to a Depot from a local directory - -**USAGE** - -``` -hab pkg bulkupload [FLAGS] [OPTIONS] -``` - -**FLAGS** - -``` ---auto-build Enable auto-build for all packages in this upload. Only applicable to SaaS Builder - --auto-create-origins Skip the confirmation prompt and automatically create origins that do not exist in the target Builder - --force Skip checking availability of package and force uploads, potentially overwriting a stored copy of a package --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --z, --auth Authentication token for Builder --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) --c, --channel Optional additional release channel to upload package to. Packages are always uploaded to unstable, regardless of the value of this option -``` - -**ARGS** - -``` - Directory Path from which artifacts will be uploaded -``` - - - ---- - -### hab pkg channels - -Find out what channels a package belongs to - -**USAGE** - -``` -hab pkg channels [OPTIONS] [PKG_TARGET] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --z, --auth Authentication token for Builder --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) -``` - -**ARGS** - -``` - A fully qualified package identifier (ex: core/busybox-static/1.42.2/20170513215502) - A package target (ex: x86_64-windows) (default: system appropriate target) [env: HAB_PACKAGE_TARGET=] -``` - - - ---- - -### hab pkg config - -Displays the default configuration options for a service - -**USAGE** - -``` -hab pkg config -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - - -**ARGS** - -``` - A package identifier (ex: core/redis, core/busybox-static/1.42.2) -``` - - - ---- - -### hab pkg delete - -Removes a package from Builder - -**USAGE** - -``` -hab pkg delete [OPTIONS] [PKG_TARGET] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --z, --auth Authentication token for Builder --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) -``` - -**ARGS** - -``` - A fully qualified package identifier (ex: core/busybox-static/1.42.2/20170513215502) - A package target (ex: x86_64-windows) (default: system appropriate target) [env: HAB_PACKAGE_TARGET=] -``` - - - ---- - -### hab pkg demote - -Demote a package from a specified channel - -**USAGE** - -``` -hab pkg demote [OPTIONS] [PKG_TARGET] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --z, --auth Authentication token for Builder --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) -``` - -**ARGS** - -``` - A fully qualified package identifier (ex: core/busybox-static/1.42.2/20170513215502) - Demote from the specified release channel - A package target (ex: x86_64-windows) (default: system appropriate target) [env: HAB_PACKAGE_TARGET=] -``` - - - ---- - -### hab pkg dependencies - -Returns the Habitat Artifact dependencies. By default it will return the direct dependencies of the package - -**USAGE** - -``` -hab pkg dependencies [FLAGS] -``` - -**FLAGS** - -``` --r, --reverse Show packages which are dependant on this one --t, --transitive Show transitive dependencies --h, --help Prints help information --V, --version Prints version information -``` - - -**ARGS** - -``` - A package identifier (ex: core/redis, core/busybox-static/1.42.2) -``` - - - ---- - -### hab pkg download - -Download Habitat artifacts (including dependencies and keys) from Builder - -**USAGE** - -``` -hab pkg download [FLAGS] [OPTIONS] [--] [PKG_IDENT]... -``` - -**FLAGS** - -``` ---ignore-missing-seeds Ignore packages specified that are not present on the target Builder - --verify Verify package integrity after download (Warning: this can be slow) --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --z, --auth Authentication token for Builder --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) --c, --channel Download from the specified release channel. Overridden if channel is specified in toml file [env: HAB_BLDR_CHANNEL=] [default: stable] - --download-directory The path to store downloaded artifacts - --file ... File with newline separated package identifiers, or TOML file (ending with .toml extension) - --t, --target Target architecture to fetch. E.g. x86_64-linux. Overridden if architecture is specified in toml file -``` - -**ARGS** - -``` -... One or more Habitat package identifiers (ex: acme/redis) -``` - - - ---- - -### hab pkg env - -Prints the runtime environment of a specific installed package - -**USAGE** - -``` -hab pkg env -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - - -**ARGS** - -``` - A package identifier (ex: core/redis, core/busybox-static/1.42.2) -``` - - - ---- - -### hab pkg exec - -Executes a command using the 'PATH' context of an installed package - -**USAGE** - -``` -hab pkg exec [ARGS]... -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - - -**ARGS** - -``` - A package identifier (ex: core/redis, core/busybox-static/1.42.2) - The command to execute (ex: ls) -... Arguments to the command -``` - - - ---- - -### hab pkg export - -Exports the package to the specified format - -**USAGE** - -``` -hab pkg export -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - - - - -**SUBCOMMANDS** - -| Command | Description | -| ------- | ----------- | -| [hab pkg export cf](#hab-pkg-export-cf) | Cloud Foundry exporter | -| [hab pkg export container](#hab-pkg-export-container) | Container exporter | -| [hab pkg export mesos](#hab-pkg-export-mesos) | Mesos exporter | -| [hab pkg export tar](#hab-pkg-export-tar) | Tar exporter | ---- - -### hab pkg hash - -Generates a blake2b hashsum from a target at any given filepath - -**USAGE** - -``` -hab pkg hash [SOURCE] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - - -**ARGS** - -``` - A filepath of the target -``` - - - ---- - -### hab pkg info - -Returns the Habitat Artifact information - -**USAGE** - -``` -hab pkg info [FLAGS] -``` - -**FLAGS** - -``` --j, --json Output will be rendered in json. (Includes extended metadata) --h, --help Prints help information --V, --version Prints version information -``` - - -**ARGS** - -``` - A path to a Habitat Artifact (ex: /home/acme-redis-3.0.7-21120102031201-x86_64-linux.hart) -``` - - - ---- - -### hab pkg install - -Installs a Habitat package from Builder or locally from a Habitat Artifact - -**USAGE** - -``` -hab pkg install [FLAGS] [OPTIONS] ... -``` - -**FLAGS** - -``` --b, --binlink Binlink all binaries from installed package(s) into BINLINK_DIR --f, --force Overwrite existing binlinks - --ignore-install-hook Do not run any install hooks --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --z, --auth Authentication token for Builder - --binlink-dir Binlink all binaries from installed package(s) into BINLINK_DIR [env: HAB_BINLINK_DIR=] [default: /bin] --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) --c, --channel Install from the specified release channel [env: HAB_BLDR_CHANNEL=] [default: stable] -``` - -**ARGS** - -``` -... One or more Habitat package identifiers (ex: acme/redis) and/or filepaths to a Habitat Artifact (ex: /home/acme-redis-3.0.7-21120102031201-x86_64-linux.hart) -``` - - - ---- - -### hab pkg list - -List all versions of installed packages - -**USAGE** - -``` -hab pkg list [OPTIONS] <--all|--origin |PKG_IDENT> -``` - -**FLAGS** - -``` --a, --all List all installed packages --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --o, --origin An origin to list -``` - -**ARGS** - -``` - A package identifier (ex: core/redis, core/busybox-static/1.42.2) -``` - - - ---- - -### hab pkg path - -Prints the path to a specific installed release of a package - -**USAGE** - -``` -hab pkg path -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - - -**ARGS** - -``` - A package identifier (ex: core/redis, core/busybox-static/1.42.2) -``` - - - ---- - -### hab pkg promote - -Promote a package to a specified channel - -**USAGE** - -``` -hab pkg promote [OPTIONS] [PKG_TARGET] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --z, --auth Authentication token for Builder --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) -``` - -**ARGS** - -``` - A fully qualified package identifier (ex: core/busybox-static/1.42.2/20170513215502) - Promote to the specified release channel - A package target (ex: x86_64-windows) (default: system appropriate target) [env: HAB_PACKAGE_TARGET=] -``` - - - ---- - -### hab pkg provides - -Search installed Habitat packages for a given file - -**USAGE** - -``` -hab pkg provides [FLAGS] -``` - -**FLAGS** - -``` --p Show full path to file --r Show fully qualified package names (ex: core/busybox-static/1.24.2/20160708162350) --h, --help Prints help information --V, --version Prints version information -``` - - -**ARGS** - -``` - File name to find -``` - - - ---- - -### hab pkg search - -Search for a package in Builder - -**USAGE** - -``` -hab pkg search [OPTIONS] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --z, --auth Authentication token for Builder --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) --l, --limit Limit how many packages to retrieve [default: 50] -``` - -**ARGS** - -``` - Search term -``` - - - ---- - -### hab pkg sign - -Signs an archive with an origin key, generating a Habitat Artifact - -**USAGE** - -``` -hab pkg sign [OPTIONS] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` ---cache-key-path Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=] [default: /hab/cache/keys] - --origin Origin key used to create signature -``` - -**ARGS** - -``` - A path to a source archive file (ex: /home/acme-redis-3.0.7-21120102031201.tar.xz) - The destination path to the signed Habitat Artifact (ex: /home/acme-redis-3.0.7-21120102031201- x86_64-linux.hart) -``` - - - ---- - -### hab pkg uninstall - -Safely uninstall a package and dependencies from the local filesystem - -**USAGE** - -``` -hab pkg uninstall [FLAGS] [OPTIONS] -``` - -**FLAGS** - -``` --d, --dryrun Just show what would be uninstalled, don't actually do it - --ignore-uninstall-hook Do not run any uninstall hooks - --no-deps Don't uninstall dependencies --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` ---exclude ... Identifier of one or more packages that should not be uninstalled. (ex: core/redis, core/busybox-static/1.42.2/21120102031201) - --keep-latest Only keep this number of latest packages uninstalling all others -``` - -**ARGS** - -``` - A package identifier (ex: core/redis, core/busybox-static/1.42.2) -``` - - - ---- - -### hab pkg upload - -Uploads a local Habitat Artifact to Builder - -**USAGE** - -``` -hab pkg upload [FLAGS] [OPTIONS] ... -``` - -**FLAGS** - -``` ---force Skips checking availability of package and force uploads, potentially overwriting a stored copy of a package. (default: false) - --no-build Disable auto-build for all packages in this upload --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --z, --auth Authentication token for Builder --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) - --cache-key-path Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=] [default: /hab/cache/keys] --c, --channel Optional additional release channel to upload package to. Packages are always uploaded to unstable, regardless of the value of this option -``` - -**ARGS** - -``` -... One or more filepaths to a Habitat Artifact (ex: /home/acme-redis-3.0.7-21120102031201-x86_64- linux.hart) -``` - - - ---- - -### hab pkg verify - -Verifies a Habitat Artifact with an origin key - -**USAGE** - -``` -hab pkg verify [OPTIONS] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` ---cache-key-path Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=] [default: /hab/cache/keys] -``` - -**ARGS** - -``` - A path to a Habitat Artifact (ex: /home/acme-redis-3.0.7-21120102031201-x86_64-linux.hart) -``` - - - ---- - -## hab plan - -Commands relating to plans and other app-specific configuration - -**USAGE** - -``` -hab plan -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - - - - -**SUBCOMMANDS** - -| Command | Description | -| ------- | ----------- | -| [hab plan init](#hab-plan-init) | Generates common package specific configuration files. Executing without argument will create a habitat directory in your current folder for the plan. If PKG_NAME is specified it will create a folder with that name. Environment variables (those starting with 'pkg_') that are set will be used in the generated plan | -| [hab plan render](#hab-plan-render) | Renders plan config files | ---- - -### hab plan init - -Generates common package specific configuration files. Executing without argument will create a habitat directory in - -**USAGE** - -``` -hab plan init [FLAGS] [OPTIONS] [PKG_NAME] -``` - -**FLAGS** - -``` --m, --min Create a minimal plan file --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --o, --origin Origin for the new app --s, --scaffolding Specify explicit Scaffolding for your app (ex: node, ruby) -``` - -**ARGS** - -``` - Name for the new app -``` - - - ---- - -### hab plan render - -Renders plan config files - -**USAGE** - -``` -hab plan render [FLAGS] [OPTIONS] -``` - -**FLAGS** - -``` --n, --no-render Don't write anything to disk, ignores --render-dir --p, --print Prints config to STDOUT --q, --quiet Don't print any helper messages. When used with --print will only print config file --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --d, --default-toml Path to default.toml [default: ./default.toml] --m, --mock-data Path to json file with mock data for template, defaults to none --r, --render-dir Path to render templates [default: ./results] --u, --user-toml Path to user.toml, defaults to none -``` - -**ARGS** - -``` - Path to config to render -``` - - - ---- - -## hab ring - -Commands relating to Habitat rings - -**USAGE** - -``` -hab ring -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - - - - -**SUBCOMMANDS** - -| Command | Description | -| ------- | ----------- | -| [hab ring key](#hab-ring-key) | Commands relating to Habitat ring keys | ---- - -### hab ring key - -Commands relating to Habitat ring keys - -**USAGE** - -``` -hab ring key -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - - - - -**SUBCOMMANDS** - -| Command | Description | -| ------- | ----------- | -| [hab ring key export](#hab-ring-key-export) | Outputs the latest ring key contents to stdout | -| [hab ring key generate](#hab-ring-key-generate) | Generates a Habitat ring key | -| [hab ring key import](#hab-ring-key-import) | Reads a stdin stream containing ring key contents and writes the key to disk | ---- - -### hab ring key export - -Outputs the latest ring key contents to stdout - -**USAGE** - -``` -hab ring key export [OPTIONS] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` ---cache-key-path Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=] [default: /hab/cache/keys] -``` - -**ARGS** - -``` - Ring key name -``` - - - ---- - -### hab ring key generate - -Generates a Habitat ring key - -**USAGE** - -``` -hab ring key generate [OPTIONS] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` ---cache-key-path Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=] [default: /hab/cache/keys] -``` - -**ARGS** - -``` - Ring key name -``` - - - ---- - -### hab ring key import - -Reads a stdin stream containing ring key contents and writes the key to disk - -**USAGE** - -``` -hab ring key import [OPTIONS] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` ---cache-key-path Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=] [default: /hab/cache/keys] -``` - - - - ---- - -## hab studio - - - -**USAGE** - -``` -hab studio [FLAGS] [OPTIONS] [ARG ..] -``` - - - - - -**SUBCOMMANDS** - -| Command | Description | -| ------- | ----------- | -| [hab studio build](#hab-studio-build) | Build using a Studio | -| [hab studio enter](#hab-studio-enter) | Interactively enter a Studio | -| [hab studio new](#hab-studio-new) | Creates a new Studio | -| [hab studio rm](#hab-studio-rm) | Destroys a Studio | -| [hab studio run](#hab-studio-run) | Run a command in a Studio | -| [hab studio version](#hab-studio-version) | Prints version information | ---- - -### hab studio build - - - -**USAGE** - -``` -hab studio [COMMON_FLAGS] [COMMON_OPTIONS] build [FLAGS] [PLAN_DIR] -``` - -**FLAGS** - -``` --R Reuse a previous Studio state (default: clean up before building) -``` - - - - - ---- - -### hab studio enter - - - -**USAGE** - -``` -hab studio [COMMON_FLAGS] [COMMON_OPTIONS] enter -``` - - - - - - ---- - -### hab studio new - - - -**USAGE** - -``` -hab studio [COMMON_FLAGS] [COMMON_OPTIONS] new -``` - - - - - - ---- - -### hab studio rm - - - -**USAGE** - -``` -hab studio [COMMON_FLAGS] [COMMON_OPTIONS] rm -``` - - - - - - ---- - -### hab studio run - - - -**USAGE** - -``` -hab studio [COMMON_FLAGS] [COMMON_OPTIONS] run [CMD] [ARG ..] -``` - - - - - - ---- - -### hab studio version - - - - - - - - - ---- - -## hab sup - - - -**USAGE** - -``` -hab sup -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - - - - -**SUBCOMMANDS** - -| Command | Description | -| ------- | ----------- | -| [hab sup bash](#hab-sup-bash) | Start an interactive Bash-like shell | -| [hab sup depart](#hab-sup-depart) | Depart a Supervisor from the gossip ring; kicking and banning the target from joining again with the same member-id | -| [hab sup restart](#hab-sup-restart) | Restart a Supervisor without restarting its services | -| [hab sup run](#hab-sup-run) | Run the Habitat Supervisor | -| [hab sup secret](#hab-sup-secret) | Commands relating to a Habitat Supervisor's Control Gateway secret | -| [hab sup sh](#hab-sup-sh) | Start an interactive Bourne-like shell | -| [hab sup status](#hab-sup-status) | Query the status of Habitat services | -| [hab sup term](#hab-sup-term) | Gracefully terminate the Habitat Supervisor and all of its running services | ---- - -### hab sup bash - -Start an interactive Bash-like shell - -**USAGE** - -``` -hab sup bash -``` - -**FLAGS** - -``` --h, --help Prints help information -``` - - - - - ---- - -### hab sup depart - -Depart a Supervisor from the gossip ring; kicking and banning the target from joining again with the same member-id - -**USAGE** - -``` -hab sup depart [OPTIONS] -``` - -**FLAGS** - -``` --h, --help Prints help information -``` - -**OPTIONS** - -``` --r, --remote-sup Address to a remote Supervisor's Control Gateway [default: 127.0.0.1:9632] -``` - -**ARGS** - -``` - The member-id of the Supervisor to depart -``` - - - ---- - -### hab sup restart - -Restart a Supervisor without restarting its services - -**USAGE** - -``` -hab sup restart [OPTIONS] -``` - -**FLAGS** - -``` --h, --help Prints help information -``` - -**OPTIONS** - -``` --r, --remote-sup Address to a remote Supervisor's Control Gateway [default: 127.0.0.1:9632] -``` - - - - ---- - -### hab sup run - -Run the Habitat Supervisor - -**USAGE** - -``` -hab sup run [FLAGS] [OPTIONS] [--] [PKG_IDENT_OR_ARTIFACT] -``` - -**FLAGS** - -``` --A, --auto-update Enable automatic updates for the Supervisor itself - --generate-config Generate a TOML config --D, --http-disable Disable the HTTP Gateway completely - --json-logging Use structured JSON logging for the Supervisor - --local-gossip-mode Start the supervisor in local mode - --no-color Turn ANSI color off --I, --permanent-peer Make this Supervisor a permanent peer --v Verbose output showing file and line/column numbers --h, --help Prints help information -``` - -**OPTIONS** - -``` ---auto-update-period The period of time in seconds between Supervisor update checks [default: 60] - - --bind ... One or more service groups to bind to a configuration - - --binding-mode Governs how the presence or absence of binds affects service startup [default: strict] [possible values: strict, relaxed] --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) - --cache-key-path Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=] [default: /hab/cache/keys] - - --ca-certs The CA certificate for HTTP Gateway TLS encryption - - --certs The server certificates for HTTP Gateway TLS encryption - - --channel Receive updates from the specified release channel [default: stable] - - --config-files ... Paths to config files to read - --config-from Use the package config from this path rather than the package itself - - --ctl-client-ca-certificate Enable client authentication for the control gateway and set the certificate authority to use when authenticating the client [default: /hab/cache/keys/ctl] - --ctl-server-certificate The control gateway server's TLS certificate [default: /hab/cache/keys/ctl] - - --ctl-server-key Enable TLS for the control gateway and set the server's private key [default: /hab/cache/keys/ctl] - - --event-meta ... An arbitrary key-value pair to add to each event generated by this Supervisor - - --event-stream-application The name of the application for event stream purposes - - --event-stream-connect-timeout Event stream connection timeout before exiting the Supervisor [env: HAB_EVENT_STREAM_CONNECT_TIMEOUT=] default: 0] - --event-stream-environment The name of the environment for event stream purposes - - --event-stream-server-certificate The path to Chef Automate's event stream certificate used to establish a TLS connection - - --event-stream-site The name of the site where this Supervisor is running for event stream purposes - - --event-stream-token The authentication token for connecting the event stream to Chef Automate [env: HAB_AUTOMATE_AUTH_TOKEN=] - - --event-stream-url The event stream connection url used to send events to Chef Automate - - --group The service group with shared config and topology [default: default] - --i, --health-check-interval The interval in seconds on which to run health checks [default: 30] - - --keep-latest-packages Automatically cleanup old packages [env: HAB_KEEP_LATEST_PACKAGES=] - - --key The private key for HTTP Gateway TLS encryption - - --listen-ctl The listen address for the Control Gateway [env: HAB_LISTEN_CTL=] [default: 127.0.0.1:9632] - - --listen-gossip The listen address for the Gossip Gateway [env: HAB_LISTEN_GOSSIP=] [default: 0.0.0.0:9638] - - --listen-http The listen address for the HTTP Gateway [env: HAB_LISTEN_HTTP=] [default: 0.0.0.0:9631] - - --org The organization the Supervisor and its services are part of - - --peer ... The listen address of one or more initial peers (IP[:PORT]) - - --peer-watch-file Watch this file for connecting to the ring - --r, --ring The name of the ring used by the Supervisor when running with wire encryption [env: HAB_RING=] - - --service-max-backoff-period The maximum period of time in seconds to wait before attempting to restart a service that failed to start up default: 0] - --service-min-backoff-period The minimum period of time in seconds to wait before attempting to restart a service that failed to start up default: 0] - --service-restart-cooldown-period The period of time in seconds to wait before assuming that a service started up successfully after a restart default: 300] - --service-update-period The period of time in seconds between service update checks [default: 60] - - --shutdown-timeout The delay in seconds after sending the shutdown signal to wait before killing the service process - --s, --strategy The update strategy [default: none] [possible values: none, at-once, rolling] - - --sys-ip-address The IPv4 address to use as the sys.ip template variable - --t, --topology Service topology [possible values: standalone, leader] - - --update-condition The condition dictating when this service should update [default: latest] [possible values: latest, track- channel] -``` - -**ARGS** - -``` - Load a Habitat package as part of the Supervisor startup -``` - - - ---- - -### hab sup secret - -Commands relating to a Habitat Supervisor's Control Gateway secret - -**USAGE** - -``` -hab sup secret -``` - -**FLAGS** - -``` --h, --help Prints help information -``` - - - - -**SUBCOMMANDS** - -| Command | Description | -| ------- | ----------- | -| [hab sup secret generate](#hab-sup-secret-generate) | Generate a secret key to use as a Supervisor's Control Gateway secret | -| [hab sup secret generate-tls](#hab-sup-secret-generate-tls) | Generate a private key and certificate for the Supervisor's Control Gateway TLS connection | ---- - -### hab sup secret generate - -Generate a secret key to use as a Supervisor's Control Gateway secret - -**USAGE** - -``` -hab sup secret generate -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - - - - - ---- - -### hab sup secret generate-tls - -Generate a private key and certificate for the Supervisor's Control Gateway TLS connection - -**USAGE** - -``` -hab sup secret generate-tls [OPTIONS] --subject-alternative-name -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` ---path The directory to store the generated private key and certificate [default: /hab/cache/keys/ctl] - - --subject-alternative-name The DNS name to use in the certificates subject alternative name extension -``` - - - - ---- - -### hab sup sh - -Start an interactive Bourne-like shell - -**USAGE** - -``` -hab sup sh -``` - -**FLAGS** - -``` --h, --help Prints help information -``` - - - - - ---- - -### hab sup status - -Query the status of Habitat services - -**USAGE** - -``` -hab sup status [OPTIONS] [PKG_IDENT] -``` - -**FLAGS** - -``` --h, --help Prints help information -``` - -**OPTIONS** - -``` --r, --remote-sup Address to a remote Supervisor's Control Gateway [default: 127.0.0.1:9632] -``` - -**ARGS** - -``` - A package identifier (ex: core/redis, core/busybox-static/1.42.2) -``` - - - ---- - -### hab sup term - -Gracefully terminate the Habitat Supervisor and all of its running services - -**USAGE** - -``` -hab sup term -``` - -**FLAGS** - -``` --h, --help Prints help information -``` - - - - - ---- - -## hab supportbundle - -Create a tarball of Habitat Supervisor data to send to support - -**USAGE** - -``` -hab supportbundle -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - - - - - ---- - -## hab svc - -Commands relating to Habitat services - -**USAGE** - -``` -hab svc -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - - - - -**SUBCOMMANDS** - -| Command | Description | -| ------- | ----------- | -| [hab svc key](#hab-svc-key) | Commands relating to Habitat service keys | -| [hab svc load](#hab-svc-load) | Load a service to be started and supervised by Habitat from a package identifier. If an installed package doesn't satisfy the given package identifier, a suitable package will be installed from Builder | -| [hab svc start](#hab-svc-start) | Start a loaded, but stopped, Habitat service | -| [hab svc status](#hab-svc-status) | Query the status of Habitat services | -| [hab svc stop](#hab-svc-stop) | Stop a running Habitat service | -| [hab svc unload](#hab-svc-unload) | Unload a service loaded by the Habitat Supervisor. If the service is running it will additionally be stopped | -| [hab svc update](#hab-svc-update) | Update how the Supervisor manages an already-running service. Depending on the given changes, they may be able to be applied without restarting the service | ---- - -### hab svc key - -Commands relating to Habitat service keys - -**USAGE** - -``` -hab svc key -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - - - - -**SUBCOMMANDS** - -| Command | Description | -| ------- | ----------- | -| [hab svc key generate](#hab-svc-key-generate) | Generates a Habitat service key | ---- - -### hab svc key generate - -Generates a Habitat service key - -**USAGE** - -``` -hab svc key generate [OPTIONS] [ORG] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` ---cache-key-path Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=] [default: /hab/cache/keys] -``` - -**ARGS** - -``` - Target service group service.group[@organization] (ex: redis.default or foo.default@bazcorp) - The service organization -``` - - - ---- - -### hab svc load - -Load a service to be started and supervised by Habitat from a package identifier. If an installed package doesn't - -**USAGE** - -``` -hab svc load [FLAGS] [OPTIONS] -``` - -**FLAGS** - -``` --f, --force Load or reload an already loaded service. If the service was previously loaded and running this operation will also restart the service --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` ---bind ... One or more service groups to bind to a configuration - --binding-mode Governs how the presence or absence of binds affects service startup [default: strict] [possible values: strict, relaxed] --u, --url Specify an alternate Builder endpoint. If not specified, the value will be taken from the HAB_BLDR_URL environment variable if defined. (default: https://bldr.habitat.sh) - --channel Receive updates from the specified release channel [default: stable] - - --config-from Use the package config from this path rather than the package itself - - --group The service group with shared config and topology [default: default] - --i, --health-check-interval The interval in seconds on which to run health checks [default: 30] - --r, --remote-sup Address to a remote Supervisor's Control Gateway [default: 127.0.0.1:9632] - - --shutdown-timeout The delay in seconds after sending the shutdown signal to wait before killing the service process - --s, --strategy The update strategy [default: none] [possible values: none, at-once, rolling] - --t, --topology Service topology [possible values: standalone, leader] - --update-condition The condition dictating when this service should update [default: latest] [possible values: latest, track- channel] -``` - -**ARGS** - -``` - A package identifier (ex: core/redis, core/busybox-static/1.42.2) -``` - - - ---- - -### hab svc start - -Start a loaded, but stopped, Habitat service - -**USAGE** - -``` -hab svc start [OPTIONS] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --r, --remote-sup Address to a remote Supervisor's Control Gateway [default: 127.0.0.1:9632] -``` - -**ARGS** - -``` - A package identifier (ex: core/redis, core/busybox-static/1.42.2) -``` - - - ---- - -### hab svc status - -Query the status of Habitat services - -**USAGE** - -``` -hab svc status [OPTIONS] [PKG_IDENT] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --r, --remote-sup Address to a remote Supervisor's Control Gateway [default: 127.0.0.1:9632] -``` - -**ARGS** - -``` - A package identifier (ex: core/redis, core/busybox-static/1.42.2) -``` - - - ---- - -### hab svc stop - -Stop a running Habitat service - -**USAGE** - -``` -hab svc stop [OPTIONS] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --r, --remote-sup Address to a remote Supervisor's Control Gateway [default: 127.0.0.1:9632] - - --shutdown-timeout The delay in seconds after sending the shutdown signal to wait before killing the service process -``` - -**ARGS** - -``` - A package identifier (ex: core/redis, core/busybox-static/1.42.2) -``` - - - ---- - -### hab svc unload - -Unload a service loaded by the Habitat Supervisor. If the service is running it will additionally be stopped - -**USAGE** - -``` -hab svc unload [OPTIONS] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` --r, --remote-sup Address to a remote Supervisor's Control Gateway [default: 127.0.0.1:9632] - - --shutdown-timeout The delay in seconds after sending the shutdown signal to wait before killing the service process -``` - -**ARGS** - -``` - A package identifier (ex: core/redis, core/busybox-static/1.42.2) -``` - - - ---- - -### hab svc update - -Update how the Supervisor manages an already-running service. Depending on the given changes, they may be able to be - -**USAGE** - -``` -hab svc update [OPTIONS] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` ---bind ... One or more service groups to bind to a configuration - --binding-mode Governs how the presence or absence of binds affects service startup [possible values: strict, relaxed] - --u, --url Specify an alternate Builder endpoint - --channel Receive updates from the specified release channel - --group The service group with shared config and topology --i, --health-check-interval The interval in seconds on which to run health checks --r, --remote-sup Address to a remote Supervisor's Control Gateway [default: 127.0.0.1:9632] - - --shutdown-timeout The delay in seconds after sending the shutdown signal to wait before killing the service process - --s, --strategy The update strategy [possible values: none, at-once, rolling] --t, --topology Service topology [possible values: standalone, leader] - --update-condition The condition dictating when this service should update [possible values: latest, track-channel] -``` - -**ARGS** - -``` - A package identifier (ex: core/redis, core/busybox-static/1.42.2) -``` - - - ---- - -## hab user - -Commands relating to Habitat users - -**USAGE** - -``` -hab user -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - - - - -**SUBCOMMANDS** - -| Command | Description | -| ------- | ----------- | -| [hab user key](#hab-user-key) | Commands relating to Habitat user keys | ---- - -### hab user key - -Commands relating to Habitat user keys - -**USAGE** - -``` -hab user key -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - - - - -**SUBCOMMANDS** - -| Command | Description | -| ------- | ----------- | -| [hab user key generate](#hab-user-key-generate) | Generates a Habitat user key | ---- - -### hab user key generate - -Generates a Habitat user key - -**USAGE** - -``` -hab user key generate [OPTIONS] -``` - -**FLAGS** - -``` --h, --help Prints help information --V, --version Prints version information -``` - -**OPTIONS** - -``` ---cache-key-path Cache for creating and searching for encryption keys [env: HAB_CACHE_KEY_PATH=] [default: /hab/cache/keys] -``` - -**ARGS** - -``` - Name of the user key -``` - - - ---- -