Skip to main content

Run VirtuAI deep agents on your local machine

Project description

VirtuAI CLI

Run VirtuAI deep agents on your local machine.

Installation

pip install virtuai-cli

Requires Python 3.11+.

Quick Start

1. Pair your machine

Open the VirtuAI portal, go to Settings → CLI, generate a pairing code, then run:

virtuai pair <CODE>

2. Start the local runner

virtuai run

Keep this terminal open while using VirtuAI. The agent can now execute shell commands on your machine.

3. Stop

Press Ctrl+C to stop the runner. Your workspace pairing persists.

Commands

Command Description
virtuai pair <code> Pair this machine with a VirtuAI workspace
virtuai run Start the local runner
virtuai status Show pairing and connection status
virtuai logs Show recent commands executed by the agent
virtuai unpair Revoke the current pairing
virtuai login Authenticate with your VirtuAI account (browser flow)

Options

virtuai run --workdir /path/to/dir   # Set a custom working directory
virtuai run --server https://...     # Connect to a custom VirtuAI server

Security

  • Commands run under your local user account with your file system permissions.
  • All communication is over encrypted WebSocket (WSS).
  • The agent can only run when virtuai run is active — no background daemon.
  • An audit log of executed commands is written to ~/.virtuai/audit.log.

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

virtuai_cli-0.5.0.tar.gz (20.9 kB view details)

Uploaded Source

Built Distribution

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

virtuai_cli-0.5.0-py3-none-any.whl (25.2 kB view details)

Uploaded Python 3

File details

Details for the file virtuai_cli-0.5.0.tar.gz.

File metadata

  • Download URL: virtuai_cli-0.5.0.tar.gz
  • Upload date:
  • Size: 20.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.11

File hashes

Hashes for virtuai_cli-0.5.0.tar.gz
Algorithm Hash digest
SHA256 781d25807fd8e0893785cc00f9b1fef9144aa5b3043343f6594ce3f9466a0d07
MD5 4ed709f40bd0dbd6e0b81811c63fc683
BLAKE2b-256 4e2bc92b309046baadf5f106f5d645c39857d9361880a56462438ba05e9721f4

See more details on using hashes here.

File details

Details for the file virtuai_cli-0.5.0-py3-none-any.whl.

File metadata

File hashes

Hashes for virtuai_cli-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 88fcc60ea203ba6197bcd3da47150adbfe49fafcf2cc0189b1b08b4e015a707c
MD5 525c2eceafdc56eb34d35d331fe3a569
BLAKE2b-256 8fa8762dad24749ce1eecc1001dd5c0fcb3d1886e96da01cf99248220f800211

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