Skip to main content

vr.cli

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.

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.

Metadata

Release files for vr.cli 2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for vr.cli 2.0
File Size Uploaded
vr.cli-2.0.zip 8.4 kB Details

Release files / vr.cli-2.0.zip

Download URL vr.cli-2.0.zip
Size 8.4 kB
Tags Source
SHA-256 checksum
How to use checksums
035d34be26d17748a72ef468cc465420879dcf6a0c2c33da50ab187f35cef648
BLAKE2b-256 checksum
How to use checksums
7cade7026a51aa07d7b8c649e82b4317d8cf6003db991127ae3ab7d1f86d8ca8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

4.2

2 release files

4.1

2 release files

4.0

2 release files

3.4

2 release files

3.3

2 release files

3.2

2 release files

3.0

2 release files

2.11

2 release files

2.10

2 release files

2.9

2 release files

2.8

2 release files

2.7.4

3 release files

2.7.3

1 release file

2.7.2

2 release files

2.7.1

2 release files

2.7

1 release file

2.6

1 release file

2.5

1 release file

2.4.1

1 release file

2.4

1 release file

2.3

1 release file

2.2

1 release file

2.1

1 release file

This release

2.0 This release

1 release file

1.5

1 release file

1.4.1

1 release file

1.4

1 release file

1.3

1 release file

1.2.1

1 release file

1.2

1 release file

1.1

1 release file

1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page