@hotglue/cli
Version:
hotglue CLI tools
95 lines (66 loc) • 3.79 kB
Markdown
# @hotglue/cli [](https://npmjs.com/package/@hotglue/cli)
The [hotglue](https://hotglue.xyz) Command Line Interface (CLI)
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Configuration](#configuration)
- [Documentation](#documentation)
## Installation
You can install the CLI globally (recommended) using
```zsh
npm install -g @hotglue/cli
```
And then you can run it from anywhere using
```zsh
hotglue --help
```
Alternatively, you may install it locally in a project folder using
```zsh
npm install --save-dev @hotglue/cli
```
And then you can run the local installation from within that folder using
```zsh
npx hotglue --help
```
## Usage
```zsh
Usage: hotglue <command>
Commands:
hotglue config View global CLI settings (ie. apikey)
hotglue config set Configure global CLI settings (ie. apikey)
hotglue env download Download environment settings (ie. requirements.txt)
hotglue env deploy Deploy environment settings (ie. requirements.txt)
hotglue etl download Download ETL script files
hotglue etl deploy Deploy ETL script files
hotglue snapshots download Download snapshot files
hotglue snapshots deploy Deploy snapshot files
hotglue flows list List flows for a given environment
hotglue jobs list List all jobs for a given flow
hotglue jobs download Download jobroot files to the specified location
hotglue tenants list List the tenants in the environment
Options:
-k, --apikey Your API Key [string]
-e, --environment Environment ID [string]
-f, --flow Flow ID [string]
-t, --tap Tap ID [string]
-u, --tenant Tenant ID [string]
-j, --jobroot A job root path [string]
-d, --downwloadTo The target download location [string]
-s, --sourceFolder The source directory [string]
-o, --overwrite Overwrite existing files? [boolean]
-v, --version Show version number [boolean]
-h, --help Show help [boolean]
```
## Configuration
The [hotglue](https://hotglue.xyz) CLI derives its configuration from two places: the User/Profile settings and the Project settings.
The User settings are stored in a `config.yaml` file located at `$HOME/.hotglue/`. At the moment, it is only used to store your `apikey`.
The Project settings are stored in a hotglue rc-like file and can be created anywhere in your project's folder structure. A Project settings file can hold any of the CLI's parameters (including overriding the apikey, even though we do not recommend it) is used in order to define configuration values specific for that context
### Project configuration files
The configuration files can use any of the following names:
`hotglue.yaml`, `.hotglue.yaml`, `.hotgluerc.yaml`, `.hotgluerc.yml`, `.hotgluerc`, `.hotgluerc.json`, `.hotgluerc.js`
As the extensions suggest, the files support either yaml, json or js syntax (in case of JS, the config object has to be exported). However, we recommend using the yaml format.
### Additional info
- When deploying files, symbolic links are not followed.
## Documentation
- [hotglue CLI Documentation](https://docs.hotglue.xyz/docs/cli-overview)
- [hotglue General Documentation](https://docs.hotglue.xyz)