Skip to main content

VGS Client

Project description

VGS CLI

CircleCI

Command Line Tool for programmatic configurations on VGS.

Official Documentation

Table of Contents

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

In order to run in Docker we recommend to declare the following docker-compose.yaml:

version: '3'
services:

  cli:
    image: quay.io/verygoodsecurity/vgs-cli:${VERSION:-latest}
    env_file:
      - .env
    ports:
      - "7745:7745"
      - "8390:8390"
      - "9056:9056"
    volumes:
      - ./.tmp:/tmp

To login from browser you need to pass --service-ports option:

docker-compose run --service-ports cli vgs login

To use auto login option you need to declare the following .env file:

VGS_CLIENT_ID=<YOUR-CLIENT-ID>
VGS_CLIENT_SECRET=<YOUR-CLIENT-SECRET>

Run the latest version with:

docker-compose run cli vgs --version

Run a specific version:

VERSION=[VERSION] docker-compose run cli vgs --version

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 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=vgscliadmin.admin:activate
    
    [vgs.get.plugins]
    preferences=vgscliadmin.admin:get_preferences
'''

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for vgs-cli, version 1.4.0
Filename, size File type Python version Upload date Hashes
Filename, size vgs-cli-1.4.0.tar.gz (13.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page