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/travis/yougov/vr.cli/master.svg

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

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 or by setting VELOCIRAPTOR_USERNAME environment variable.

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.

Environment Variables

For unattended use, it’s also possible to supply authentication credentials to Velociraptor by setting the VELOCIRAPTOR_USERNAME and VELOCIRAPTOR_PASSWORD environment variables, which will supersede the interactive values above. This technique is strongly discouraged for interactive use.

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-3.2.tar.gz (11.5 kB view details)

Uploaded Source

Built Distribution

vr.cli-3.2-py2.py3-none-any.whl (7.7 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for vr.cli-3.2.tar.gz
Algorithm Hash digest
SHA256 4a43985499405e82c7aa528566ff7b5824b3bbdc968468cc878f358b116ab2cc
MD5 f19dc5fb07a5eaf702ca92bc7c045694
BLAKE2b-256 f5ad8186f034699e2815766e81f4a0f492a6d789e12255db75559c335451edbb

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for vr.cli-3.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b019a36c8d8336ea3110161fa452854ac41a444a28fd50aabe312161cb833547
MD5 fea83c9415952114d8de34839022f358
BLAKE2b-256 8554781469d3f1044f04946c6f16fc40ee515f055713613073b5d3cee0dabdb2

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