For the complete documentation index, see llms.txt. This page is also available as Markdown.
Getting Started
VGS CLI is a developer tool that helps you build, test, and manage your configurations in VGS from a terminal. It enables programmatic usage of VGS APIs in code or as a part of CI/CD pipelines.
Install
VGS CLI can be installed from PyPI or be used in Docker. For Docker usage check our Docker page.
PyPI
This option requires Python 3 to be installed. To install the latest VGS CLI from PyPI:
Run
Verify your installation by running:
Quick Start
Step 1: Login with VGS account
After installing the CLI, you must login with your VGS account. This will prompt you to launch your browser and login to grant the CLI access to your account. You may be asked for permission to access your OS key management system (Mac OS Keychain, Linux Secret Service, Windows Credential Vault). VGS CLI uses it for the secure storage of keys used for encryption of your access tokens.
Step 2: Run your first command
You're now ready to use the CLI. Try to get your route configuration with the following command:
This command will get your route configurations in YAML format.
Next Steps
Check what else you can do. Use these guides or explore the CLI with vgs --help command.
