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.1.tar.gz (7.6 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.1-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: virtuered-0.1.1.tar.gz
  • Upload date:
  • Size: 7.6 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.1.tar.gz
Algorithm Hash digest
SHA256 6a2b88d6a909631a7d36a4366efd4ee0b060f05acec12894747fcd1b1a1ac255
MD5 3cca881452c4a9f09786b94492fe6bf1
BLAKE2b-256 10d8455e1d4c7190325d7aefb4ad8945073b5e2a7c55fac136688722c9ac93ca

See more details on using hashes here.

File details

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

File metadata

  • Download URL: virtuered-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 7.5 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9ee3e87fe4e938435a1c22f43299c9bcfba17dfa00f79faf2e39fe93d7115fb4
MD5 430439a7339f4670e8be89a565034281
BLAKE2b-256 2dacd846e2de527402021c30462e92ed21facba99a83272d7c295bbf8d538c3a

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