VGS Client
Project description
VGS CLI
Command Line Tool for programmatic configurations on VGS.
Table of Contents
Requirements
Installation
PyPI
Install the latest version from PyPI:
pip install vgs-cli
Run
Verify your installation by running:
vgs --version
Running in Docker
In order to run in Docker we recommend declaring the following docker-compose.yaml:
version: '3'
services:
cli:
image: quay.io/verygoodsecurity/vgs-cli:${VERSION:-latest}
stdin_open: true # docker run -i
tty: true # docker run -t
env_file:
- .env
command: bash
ports:
- "7745:7745"
- "8390:8390"
- "9056:9056"
First, you start the lightweight cli container in detached mode by executing:
docker-compose up -d cli
Then proceeding with login:
docker-compose exec cli vgs login
And now you are ready to execute any vgs cli command:
docker-compose exec cli vgs logs access -V tntmiph5i0n
To use auto login option you can declare the following .env file:
VGS_CLIENT_ID=<YOUR-CLIENT-ID>
VGS_CLIENT_SECRET=<YOUR-CLIENT-SECRET>
Alternatively, you can set the environment variables right in the docker-compose.yaml:
version: '3'
services:
cli:
image: quay.io/verygoodsecurity/vgs-cli:${VERSION:-latest}
stdin_open: true # docker run -i
tty: true # docker run -t
environment:
VGS_CLIENT_ID: <YOUR-CLIENT-ID>
VGS_CLIENT_SECRET: <YOUR-CLIENT-SECRET>
command: bash
ports:
- "7745:7745"
- "8390:8390"
- "9056:9056"
Run a specific version:
VERSION=[VERSION] docker-compose up -d
You can turn on debugging by appending -d or --debug right after vgs:
docker-compose exec cli vgs --debug logs access -V tntmiph5i0n
Commands
Sphinx Documentation
In order to generate Sphinx documentation:
pip install -r dev-requirements.txt
cd docs
make html
Check the generated docs:
open build/html/index.html
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 extendingvgswith sub-commandsvgs.get.plugins- for extendingvgs getwith sub-commandsvgs.apply.plugins- for extendingvgs applywith sub-commandsvgs.logs.plugins- for extendingvgs logswith sub-commands
Example:
entry_points='''
[vgs.plugins]
activate=vgscliplugin.myplugin:new_command
[vgs.get.plugins]
preferences=vgscliplugin.myplugin:new_get_command
'''
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
