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

Check our official documentation.

Commands

Automation with VGS CLI

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

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=vgscliplugin.myplugin:new_command
    
    [vgs.get.plugins]
    preferences=vgscliplugin.myplugin:new_get_command
'''

Plugin catalog

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.8.2
Filename, size File type Python version Upload date Hashes
Filename, size vgs-cli-1.8.2.tar.gz (19.3 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page