# 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.

<figure><img src="/files/a0PgncmUEp7Jkyv8nk1x" alt=""><figcaption></figcaption></figure>

## Install

VGS CLI can be installed from [PyPI](https://pypi.org/project/vgs-cli/) or be used in [Docker](https://docs.docker.com/get-docker/). For Docker usage check our [Docker](/vault/developer-tools/vgs-cli/docker.md) page.

### PyPI

This option requires [Python 3](https://www.python.org/downloads/) to be installed. To install the latest VGS CLI from [PyPI](https://pypi.org/project/vgs-cli/):

```bash
pip install vgs-cli
```

## Run

Verify your installation by running:

```bash
vgs --version
```

## 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.

```bash
vgs login
```

### Step 2: Run your first command

You're now ready to use the CLI. Try to get your route configuration with the following command:

```bash
vgs get routes --vault <VAULT_ID>
```

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.

* [Docker](/vault/developer-tools/vgs-cli/docker.md)
* [Commands](/vault/developer-tools/vgs-cli/commands.md)
* [Troubleshooting](/vault/developer-tools/vgs-cli/troubleshooting.md)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.verygoodsecurity.com/vault/developer-tools/vgs-cli/getting-started.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.