Metadata-Version: 2.4
Name: vgs-cli
Version: 1.33.0.dev1
Summary: VGS Client
Home-page: https://github.com/verygoodsecurity/vgs-cli
Author: Very Good Security
Author-email: dev@verygoodsecurity.com
License: BSD
Platform: any
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: base58<3,>=2.1.1
Requires-Dist: click-plugins<2,>=1.1.1
Requires-Dist: click<9,>=7
Requires-Dist: configobj-dev>=2019.9.1
Requires-Dist: cryptography>=44.0.1
Requires-Dist: jsonschema<5,>=3.2.0
Requires-Dist: keyring<26,>=16.1.0
Requires-Dist: keyrings.alt<6,>=3.1
Requires-Dist: pyhumps
Requires-Dist: semver<4,>=3
Requires-Dist: termcolor<3,>=2
Requires-Dist: Jinja2>=2.10
Requires-Dist: vgs-api-client<1,>=0.0.51
Requires-Dist: async-timeout
Requires-Dist: packaging<26,>=23
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: platform
Dynamic: requires-dist
Dynamic: summary

# VGS CLI

Command Line Tool for programmatic configurations on VGS.

[Official Documentation](https://docs.verygoodsecurity.com/vault/developer-tools/vgs-cli)

## Table of Contents

- [Requirements](#requirements)
- [Installation](#installation)
  - [PyPI](#pypi)
- [Run](#run)
- [Running in Docker](#running-in-docker)
- [Commands](#commands)
- [Automation with VGS CLI](#automation-with-vgs-cli)

## Requirements
[Python 3](https://www.python.org/downloads/) or [Docker](https://docs.docker.com/get-docker/).

## Installation

### PyPI
Install the latest version from [PyPI](https://pypi.org/project/vgs-cli/):
```
pip install vgs-cli
```

## Run

Verify your installation by running:
```
vgs --version
```

## Running in Docker

Check our [official documentation](https://docs.verygoodsecurity.com/vault/developer-tools/vgs-cli/docker).

## Commands

Full command reference:
- https://docs.verygoodsecurity.com/vault/developer-tools/vgs-cli/commands
- Routes YAML format (`routes.yaml`): https://docs.verygoodsecurity.com/vault/developer-tools/vgs-cli/commands#routes.yaml

Common commands:
- `vgs --help` (list all available commands)
- `vgs login` / `vgs logout`
- `vgs get vaults`
- `vgs get routes -V <TENANT_ID>` / `vgs apply routes -V <TENANT_ID> -f <FILE>` / `vgs delete routes -V <TENANT_ID> <ROUTE_ID>`
- `vgs get forms -V <TENANT_ID>` / `vgs get form -V <TENANT_ID> <FORM_ID>`
- `vgs apply form -V <TENANT_ID> -f <FILE>` or `vgs apply form -V <TENANT_ID> --json '<JSON>'` / `vgs delete form -V <TENANT_ID> <FORM_ID>`
- `vgs logs access -V <TENANT_ID>` / `vgs logs operations -V <TENANT_ID> -R <REQUEST_ID>`
- `vgs get access-credentials -V <TENANT_ID>` / `vgs generate access-credentials -V <TENANT_ID>`
- `vgs get organizations`
- `vgs certificate --help`

## Automation with VGS CLI

If you want to use the VGS CLI for automation you might be interested in creating a [service account](https://docs.verygoodsecurity.com/vault/developer-tools/vgs-cli/service-account).
