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.3.0.tar.gz (16.8 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.3.0-py3-none-any.whl (19.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for virtuai_cli-0.3.0.tar.gz
Algorithm Hash digest
SHA256 e2f5be3daccf9e9ad01e430df580ba7accafb30f27f50367ae5cc0d802640390
MD5 f8222f66731c13c7f080a42cd758cfb4
BLAKE2b-256 eaeeef2a6e9c98cc47983a60b4a57902272ff374a1c4a3615e526c3264833cbc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for virtuai_cli-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9d7c7e4a062e4db7c3bc56db76964d93140cbe9486978a1032e086a3d2ab585a
MD5 9cb670d4a88d2444031732f0aca17e95
BLAKE2b-256 301b238a487b573cc089bfd34e83902235dddc1949a1c9db8c2f2e583fffd582

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