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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for virtuai_cli-0.5.1.tar.gz
Algorithm Hash digest
SHA256 7f5a2bbc898812208588dc651420a1651702920ce98c25798c5080bf4a2d99ec
MD5 5d2530e770d0055a87030155164d3614
BLAKE2b-256 fcef7574c20adcac530ac3f78f2be017db813c2ec4e75b631ad122f1d64e3a84

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for virtuai_cli-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ebba09463289442c9dec73b5f8be647a85aba000b8887f3d554d748c5d306550
MD5 2fb4c9c71ef3daa2da94ad081f2bca41
BLAKE2b-256 0fe440520765fc2e88eb6db488fe477b1a26f9d6c0b2a8072f754810652a1218

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