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.2.1.tar.gz (16.0 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.2.1-py3-none-any.whl (18.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for virtuai_cli-0.2.1.tar.gz
Algorithm Hash digest
SHA256 7514ae64ec64b81ce43712adbe050a64342de1a947b1f82291bd42b47c6dbcdf
MD5 3d37c58a61fa5d13961faeab92235054
BLAKE2b-256 864dccaf562f5331a97b96d96b2f7aed967b35a5f91b313e01d94bb9ef1e79a4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for virtuai_cli-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c2288c4611ad6458897f4d3245a8fcce95c97d81125f5a24bc4c5483538b01af
MD5 327405434bd6186a2d1445f40b572278
BLAKE2b-256 7899ec42c1e07dc81063c97680c693afcd8cdb3e41c40077f47dde408160511e

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