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


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.

Source Distribution

vgs-cli-1.11.0.tar.gz (23.7 kB view details)

Uploaded Source

File details

Details for the file vgs-cli-1.11.0.tar.gz.

File metadata

  • Download URL: vgs-cli-1.11.0.tar.gz
  • Upload date:
  • Size: 23.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.1

File hashes

Hashes for vgs-cli-1.11.0.tar.gz
Algorithm Hash digest
SHA256 25d96174e22bc5d2c871d6ef03ec92a236bc2bfedacfcfd8fc1c32883e83d05a
MD5 73de2ea23f83250847a90813cc02b648
BLAKE2b-256 550c3f2fab31e4a25083d09cd7b3562256bf73aa84835d75875be279edb944c2

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page