vgs-cli 1.2.0

VGS Client

VGS CLI

Command Line Tool for programmatic configurations on VGS.

Table of Contents

• Requirements
• Installation
  • PyPI
• Run
• Running in Docker
• Commands
• Troubleshooting
  • Debug Mode
  • Known Issues
    • Code Signing
    • Requirements Conflicts
    • MacOS Keychain Access
    • MacOS Updates
  • Support

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

• help
• login and auto login
• logout
• routes get
• routes apply
• logs access

Troubleshooting

Debug Mode

If you're getting errors, you can turn on debug information with -d/--debug flag:

vgs -d get routes --vault <VAULT_ID>

Known Issues

These are some known issues if you're using Python distribution:

Code Signing

During login, you can receive similar errors: Authentication error occurred. Can't store password on keychain.

This is solved by signing your Python binary with the command:

codesign -f -s - $(which python)

If you're using Python version 3.7 or above you may need to specify full path of your installation. On Mac OS it look like:

codesign -f -s - /Library/Frameworks/Python.framework/Versions/3.8/Resources/Python.app/Contents/MacOS/Python

Requirements Conflicts

If you're receiving requirements conflicts during installation with PyPI, consider using VirtualEnv.

MacOS Keychain Access

• On MacOS, you can see a prompt that will ask for Keychain access. Make sure to always allow VGS CLI to store keys.

• On MacOS, if you accidentally denied Keychain access and there is no more prompts you should open Keychain Access app, then Lock and Unlock login (File -> Lock/Unlock Keychain "login"). After that you can try to login with again.

MacOS Updates

After updates of MacOS you can receive an error keyring.backends._OS_X_API.Error: (-25293, "Can't fetch password from system"). Make sure to update your local Python version to the latest and re-install VGS CLI if needed.

Support

If you're experiencing any other issues please contact [e-mail].