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.0.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.0-py3-none-any.whl (18.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: virtuai_cli-0.2.0.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.0.tar.gz
Algorithm Hash digest
SHA256 2da9e1337e1edb586eadaf7981d5189edafd407c619574603bf9cfd8cc9c8469
MD5 735224e0064c5010889aad0efe555093
BLAKE2b-256 d6059cce8f39c8e323b97e78bd81a1804b46181c43a3aec95b21759ab4e7fa2c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for virtuai_cli-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2d2918bea9f29f8dca51ed262ee938e5258a2569b37f00c766b686e2efb44c76
MD5 19914d18ca3ca870cfbab9c1721f5028
BLAKE2b-256 4c291d2f98762da1a5d7ab0bb2aa797e7862665dc2d0db040ac422c505f54af5

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