README
¶
Tharsis CLI
Tharsis CLI is a command-line interface to the Tharsis remote Terraform backend. The CLI allows managing groups, workspaces, creating runs from Terraform modules and much more.
- Groups: Create, update, delete groups and organize your workspaces in anyway desired.
- Workspaces: Create, update, delete workspaces and even assign / unassign managed identities.
- Variables: Set Terraform (including complex variables) and environment variables in groups, workspaces, or run-scoped.
- Authentication: Authenticate using either SSO or service accounts for M2M.
- CI/CD: Integrate easily into a CI/CD pipeline environment and deploy to Tharsis using a service account.
- Runs: Gracefully or forcefully cancel runs.
- Private Registries: Deploy modules from private Terraform registries.
Get started
Instructions on downloading the latest pre-built releases or building a binary from source can be found here.
Documentation
- Tharsis CLI documentation is available at https://gitlab.com/infor-cloud/martian-cloud/tharsis/tharsis-docs/-/blob/main/docs/cli/tharsis/intro.md.
Security
If you've discovered a security vulnerability in Tharsis CLI, please let us know by creating a confidential issue in this project.
Statement of support
Please submit any bugs or feature requests for Tharsis. Of course, MR's are even better. :)
License
Tharsis CLI is distributed under Mozilla Public License v2.0.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
tharsis
Package main contains the necessary functions for building the help menu and configuring the CLI library with all subcommand routes.
|
Package main contains the necessary functions for building the help menu and configuring the CLI library with all subcommand routes. |
|
internal
|
|
|
command
Package command contains the logic for processing all the commands and subcommands.
|
Package command contains the logic for processing all the commands and subcommands. |
|
external
Package external ...
|
Package external ... |
|
logger
Package logger provides context-aware and structured logging capabilities.
|
Package logger provides context-aware and structured logging capabilities. |
|
optparser
Package optparser provides the logic for parsing flags for any given command.
|
Package optparser provides the logic for parsing flags for any given command. |
|
output
Package output is responsible for formatting the final output / errors the user sees in the CLI.
|
Package output is responsible for formatting the final output / errors the user sees in the CLI. |
|
settings
Package settings contains the logic for reading, writing, associating profiles with a user's settings file.
|
Package settings contains the logic for reading, writing, associating profiles with a user's settings file. |
|
slug
Package slug is used to create Terraform slugs
|
Package slug is used to create Terraform slugs |
|
tableformatter
Package tableformatter configures the tablewriter library to display data in a tabled format used by various CLI commands.
|
Package tableformatter configures the tablewriter library to display data in a tabled format used by various CLI commands. |
|
varparser
Package varparser contains the logic for parsing Terraform and environment variables that Tharsis API supports.
|
Package varparser contains the logic for parsing Terraform and environment variables that Tharsis API supports. |
Click to show internal directories.
Click to hide internal directories.