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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for virtuai_cli-0.2.2.tar.gz
Algorithm Hash digest
SHA256 865599562e4403d1c224bbcea10b5c790c08bf5dad5250200df5522b76a3abae
MD5 d3171e57fbd8e99403528d3c9004fbd6
BLAKE2b-256 bfc43b33a0bde4983bf15320b6a4c475c70078c88a9d76d651dbb4d7e5bef748

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for virtuai_cli-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 cf52d98c3c46d6047b275c60cee0bc93223a19e58e104d6f1478e59fda25149c
MD5 883ecbe2712c2cc31882119635d579b2
BLAKE2b-256 3ddef5632ebb26e6935f1cb6f80efc205b8317b5d105ebff51a7a0a1953343bf

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