Metadata-Version: 2.1
Name: hmd-cli-configure
Version: 1.0.39
Summary: CLI tools for configuring other HMD tools
Home-page: UNKNOWN
Author: Alex Burgoon
Author-email: alex.burgoon@hmdlabs.io
License: Apache 2.0
Platform: UNKNOWN
Description-Content-Type: text/markdown
Requires-Dist: aws-secretsmanager-caching (==1.1.1.5)
Requires-Dist: boto3 (==1.21.7)
Requires-Dist: botocore (==1.24.9)
Requires-Dist: cachetools (==5.2.0)
Requires-Dist: cement (==3.0.6)
Requires-Dist: certifi (==2022.12.7)
Requires-Dist: charset-normalizer (==2.0.12)
Requires-Dist: colorlog (==6.6.0)
Requires-Dist: google-auth (==2.9.1)
Requires-Dist: hmd-cli-app (~=1.1.596)
Requires-Dist: hmd-cli-tools (~=1.1.228)
Requires-Dist: idna (==3.3)
Requires-Dist: inquirerpy (==0.3.4)
Requires-Dist: jinja2 (==3.0.3)
Requires-Dist: jmespath (==0.10.0)
Requires-Dist: kubernetes (==24.2.0)
Requires-Dist: markupsafe (==2.1.0)
Requires-Dist: oauthlib (==3.2.2)
Requires-Dist: pfzy (==0.3.4)
Requires-Dist: prompt-toolkit (==3.0.38)
Requires-Dist: pyasn1 (==0.4.8)
Requires-Dist: pyasn1-modules (==0.2.8)
Requires-Dist: python-dateutil (==2.8.2)
Requires-Dist: python-dotenv (==0.19.2)
Requires-Dist: pyyaml (==6.0)
Requires-Dist: requests (==2.28.2)
Requires-Dist: requests-oauthlib (==1.3.1)
Requires-Dist: rsa (==4.8)
Requires-Dist: s3transfer (==0.5.2)
Requires-Dist: six (==1.16.0)
Requires-Dist: urllib3 (==1.26.8)
Requires-Dist: wcwidth (==0.2.6)
Requires-Dist: websocket-client (==1.3.3)

# HMD CLI Configure

This package is a command line utility for configuring your local environment to use other HMD CLI tools.
All configuration for HMD CLI tools is done via a dotenv file located at `$HMD_HOME/.config/hmd.env`.
The path `$HMD_HOME` must be set by you to a directory that will be used with HMD tools only, and be present in your session.
It is a good idea to set this in a `.bash_profile` or similar file.

## Usage

In order to set an environment variable in the `hmd.env` file, you would use the `set-env` command and provide `key` and `value` arguments.

```
hmd configure set-env <key> <value>
```

This will update or append the following line in `hmd.env`: `key='value'`.

## Common Variables

There are some common variables that you might what to set upon first installation.

- `HMD_GH_USERNAME`: the GitHub username to use when connecting; primarily used by `hmd-cli-mickey` to fetch remote templates
- `HMD_GH_PASSWORD`: either a GitHub PAT or absolute path to file containing only the PAT. The entire file contents will be read and used.


