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.1.0.tar.gz (9.6 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.1.0-py3-none-any.whl (10.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for virtuai_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 8a64513970ae6449a70d35a5cf102d59a81bf1bdc54559600f396d1324f3b32e
MD5 17a21058449b541a090050242e7d03ab
BLAKE2b-256 d4e3334cc259495aa803f2478a7eb556357faea9331b2bcc712f2f5e55912274

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for virtuai_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5800b51736e1c69d1d120a8944a1270376d06ee29efee35cb6f4f9de17545402
MD5 54eece7d16279335fc907cb395e7278f
BLAKE2b-256 9acf4bb77f8262a4afa4617498ecfb1233452d54c8f98b82ef3361d56f90af5e

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