vgs-cli 1.31.0

VGS Client

VGS CLI

Command Line Tool for programmatic configurations on VGS.

Official Documentation

Table of Contents

• Requirements
• Installation
  • PyPI
• Run
• Running in Docker
• Commands
• Code Standards
• Automation with VGS CLI
• Sphinx Documentation
• Plugins Development

Requirements

Python 3 or Docker.

Installation

PyPI

Install the latest version from PyPI:

pip install vgs-cli

Run

Verify your installation by running:

vgs --version

Running in Docker

Check our official documentation.

Commands

Full command reference:

• https://docs.verygoodsecurity.com/vault/developer-tools/vgs-cli/commands

Common commands:

• help
• login / logout
• routes get / routes apply
• logs access
• access-credentials get / access-credentials generate
• organizations get
• vaults get
• certificates

Code Standards

We follow the defaults enforced by Black and isort (with the Black profile). A formatting workflow runs in CI and installs black, isort, and ruff. Before opening a pull request, install the tools with pip install black isort ruff and run:

black .
isort --profile black .
ruff check .

Automation with VGS CLI

If you want to use the VGS CLI for automation you might be interested in creating a service account.

Plugins Development

See Click - Developing Plugins.

In order to develop a plugin you need to register your commands to an entrypoint in setup.py.

Supported entrypoints:

• vgs.plugins - for extending vgs with sub-commands
• vgs.get.plugins - for extending vgs get with sub-commands
• vgs.apply.plugins - for extending vgs apply with sub-commands
• vgs.logs.plugins - for extending vgs logs with sub-commands

Example:

entry_points='''
    [vgs.plugins]
    activate=vgscliplugin.myplugin:new_command

    [vgs.get.plugins]
    preferences=vgscliplugin.myplugin:new_get_command
'''

Plugin catalog

• vgs-cli-admin-plugin