Skip to main content

Command-line client for Velociraptor

Project description

https://img.shields.io/pypi/v/vr.cli.svg https://img.shields.io/pypi/pyversions/vr.cli.svg https://img.shields.io/pypi/dm/vr.cli.svg https://img.shields.io/travis/yougov/vr.cli/master.svg

A command-line interface for wrangling Velociraptor swarms and automating some common operations.

License

License is indicated in the project metadata (typically one or more of the Trove classifiers). For more details, see this explanation.

Implementation

The cli provides a command-line interface around the vr.common.models.

Features

vr.cli supports several sub-commands, including:

  • build

  • swarm

  • uptests

For a complete list of commands, invoke vr.cli with –help.

Build

Simply assemble a build of an app at a given tag. This routine is useful to prime an build before doing other swarm operations.

Swarm

This routine dispatch a swarm at a given tag:

vr.cli swarm MyApp-Recipe_.* 3.0 -x Recipe_Skipped

It takes as its parameters a filter of swarm name, a version number, and optionally some excludes.

The name filter is case sensitive, but the excludes are case insensitive.

Uptests

This routine will provide a quick printout of all failing uptests.

Procs

List, start, or stop procs.

Compare Releases

Compare the configuration of any two releases (indicated by release ID).

Configuration

The vr.cli command requires a URL to communicate with the Velociraptor instance via its REST api. By default, the URL is inferred from the name deploy as resolved by DNS. If deploy resolves as deploy.example.com, vr.cli will use https://deploy.example.com as the URL. The value can be overridden by passing --url to the command or by setting the VELOCIRAPTOR_URL environment variable.

Authentication

The Velociraptor client models (found in vr.common.models) will default to using the current username (getpass.getuser). If your username on your local host doesn’t match your username in Velociraptor, you can override the username by passing --username to the command or by setting any of the environment variables searched by getuser.

vr.cli also leverages keyring to avoid entering passwords each time. To do this, it needs a system name and username. For the username, it uses the username resolved above. For the system name, it defaults to the domain name of the Velociraptor URL (as resolved above). The domain can be overridden by setting the VELOCIRAPTOR_AUTH_DOMAIN environment variable.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vr.cli-2.9.tar.gz (8.0 kB view details)

Uploaded Source

Built Distribution

vr.cli-2.9-py2.py3-none-any.whl (8.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file vr.cli-2.9.tar.gz.

File metadata

  • Download URL: vr.cli-2.9.tar.gz
  • Upload date:
  • Size: 8.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for vr.cli-2.9.tar.gz
Algorithm Hash digest
SHA256 cbe97b18e3ebd397d3aea8330fd3fe81b6d5b3928e4b5a6d20a6ddd8b8f4fb47
MD5 5eb43afaed3a516cddcf1a61ae967c75
BLAKE2b-256 0c81310d6593024b102048d81363a395bea567827ab5bfd7c5600008d66974d5

See more details on using hashes here.

Provenance

File details

Details for the file vr.cli-2.9-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for vr.cli-2.9-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 daac488fe4721854a0ff7a87fcc6e8f75842a1aa9f449df841aa4ce0962be51f
MD5 5bf569e3e4a71d99bed4f3db3289003c
BLAKE2b-256 314a352dd5b43cdb9258efcf826733e350668898aecc1fdd29e7ecebf3d46a2e

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