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.1.tar.gz (9.9 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.1-py3-none-any.whl (11.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for virtuai_cli-0.1.1.tar.gz
Algorithm Hash digest
SHA256 9e4d92ddb408f4debb84084898518df5b6d45fecc6f2b9afba539e2580a8f1f7
MD5 3165f1780135ee848ab871230e9b204a
BLAKE2b-256 f4922f7e25ce816ef436e13b5be97d877359d377053aeb0cef942ed2d7ea60ef

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for virtuai_cli-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b275757d92607b5a5bad3b1567a78217baf25a11f10b08d6df78851afd608af5
MD5 147c1e61073059fa540295d96464bbd9
BLAKE2b-256 70a2dfc8ff0916210f1699d7c6648a8aaab5f3449cd67048d500f9eaad401c98

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