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/Virtue-AI/VirtueRed-CLI.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-1.1.2.tar.gz (8.8 kB view details)

Uploaded Source

Built Distribution

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

virtuered-1.1.2-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for virtuered-1.1.2.tar.gz
Algorithm Hash digest
SHA256 345162bae1293159b4ff2dd089ac3afa1eb5ebc229354639de70c672cded4af2
MD5 2909f47ae71a252ff1878c624446cf06
BLAKE2b-256 4540fa5489261ae2154c548bdd970fed0d2f77b9a357400bb932538a77586d2c

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for virtuered-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2892e7fba1728667674106a09e8553d978a29172dc2b4e4bcc009fa77a3c74c0
MD5 ef1962663069b5c289ef962edf62f555
BLAKE2b-256 7309273a76f59b4aa139542924687a304338393062f4a653ef8e995f94eb21b4

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