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.0.tar.gz (17.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.4.0-py3-none-any.whl (20.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for virtuai_cli-0.4.0.tar.gz
Algorithm Hash digest
SHA256 d778b692e03d3661fd04675a5282154184dcfe3ddf48b414b22d5bbbaa4e3332
MD5 1dc6509fd938e65dc630ac108f2a6233
BLAKE2b-256 56300802ec4917a126e6a020e2b11dffc83fc685b2912a2cfd9726f34145b4ae

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for virtuai_cli-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3a1f3b1a70d2fe84053b2407237990486bc2478108d3f947d7e62175574e0ab3
MD5 f09d49321bfad96d50cb9572447ff3d5
BLAKE2b-256 15e12e97a442d937a0047463159f9219721a4e8a70479de02f8b420a01e62c0e

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