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 runsmonitor: Monitor ongoing scanssummary: Get detailed summary of a runreport: Generate PDF reportpause: Pause a running scanresume: Resume a paused scandelete: 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
Release history Release notifications | RSS feed
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.2.tar.gz
(7.7 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file virtuered-0.1.2.tar.gz.
File metadata
- Download URL: virtuered-0.1.2.tar.gz
- Upload date:
- Size: 7.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3dcac71def61aef56c6fe1fe8b78106414412ecbb44968a92c3cb1c3ba2906a1
|
|
| MD5 |
5e013fac33230b9189e536f87ada00c1
|
|
| BLAKE2b-256 |
f846eaae48aa4a770905cdfba8032f26dd7c46d179e21a59f826526475bbb3c4
|
File details
Details for the file virtuered-0.1.2-py3-none-any.whl.
File metadata
- Download URL: virtuered-0.1.2-py3-none-any.whl
- Upload date:
- Size: 7.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
00958c11f2fa3abc236abba66368d3571e3f478c9e6f14bf67190bd632e46357
|
|
| MD5 |
00b0cfb9270b98a2d4ba784cf8e02960
|
|
| BLAKE2b-256 |
7340c13c9e2e9ecaf0bd8ff3f864e604c6017a99935e3e506fb118f30baf2c04
|