Skip to main content

CLI tool for VirtueAI VirtueRed

Project description

VirtueRed CLI

Command line interface for VirtueAI Redteaming system.

Installation

pip install virtuered

Usage

First, ensure the VirtueRed server is running in Docker:

sudo docker run -d --cap-add=SYS_PTRACE -p 4401:4401 \
    -v /path/to/log:/app/log \
    -v /path/to/runs:/app/runs \
    --gpus all virtuered_nv

Then you can use the CLI:

# List all runs
virtuered list

# Monitor ongoing scans
virtuered monitor

# Get summary of a run
virtuered summary test_scan

# Pause/Resume a scan
virtuered pause 1
virtuered resume test_scan

# Generate report
virtuered report test_scan

# Delete a run
virtuered delete 1

For custom server URL:

virtuered --server http://localhost:4401 list

Commands

  • list: Show all runs
  • monitor: Monitor ongoing scans
  • summary: Get detailed summary of a run
  • report: Generate PDF report
  • pause: Pause a running scan
  • resume: Resume a paused scan
  • delete: Delete a run

Development

To install in development mode:

git clone https://github.com/yourusername/virtuered.git
cd virtuered
pip install -e .

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

virtuered-0.1.0.tar.gz (7.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

virtuered-0.1.0-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

Details for the file virtuered-0.1.0.tar.gz.

File metadata

  • Download URL: virtuered-0.1.0.tar.gz
  • Upload date:
  • Size: 7.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for virtuered-0.1.0.tar.gz
Algorithm Hash digest
SHA256 e3cea0a07ad13348f68a157ab5c01bbf1062c28db2b8d55809ea4ed769cd6440
MD5 9c61d18df41fd8e45b88654e7f38359d
BLAKE2b-256 7cadc41a67e20c02b21ad466ca871a70a91d2630beea53931a98d0760caa2326

See more details on using hashes here.

File details

Details for the file virtuered-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: virtuered-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for virtuered-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 df75e39cebf8710cbaacc2e1e1b7338dd89c134bad448f6ff926281d04925ef7
MD5 ca1f4d6e60c2e9f456b72a4068476c2e
BLAKE2b-256 df088e727b3f36118550d3f776398bd7e7b3d4a9f7c439db566ac130513651dc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page