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.4.1.tar.gz (18.7 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.4.1-py3-none-any.whl (21.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for virtuai_cli-0.4.1.tar.gz
Algorithm Hash digest
SHA256 454f093cf4536c9ea068ea6a42e8c1414d8665b51acf11374f81434a875df0ef
MD5 0cda4fefc2ed038c8d277507d3ce7dc0
BLAKE2b-256 10fe314eb2b5dadca75209a23103e7fb7ef891d4b168b29875094ba7eb6807b3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for virtuai_cli-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7babdfb88129e5eca621762ecf5c20ea4a8694f55c8b62864d282f134987258b
MD5 647d2c01ddf8417b09aa9c9ec7a8e6aa
BLAKE2b-256 016ca01e1b05a5f7cd9ca1089dabda65756aa8f899201f7d41ff8f64940d7328

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