Skip to content

Document tart exec usage and examples #1291

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
fkorotkov-oai wants to merge 1 commit into
base: main
Choose a base branch
from
+23 −2
Draft

Document tart exec usage and examples #1291

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 23 additions & 2 deletions Sources/tart/Commands/Exec.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,30 @@ struct ExecCustomExitCodeError: Error {

struct Exec: AsyncParsableCommand {
static var configuration = CommandConfiguration(abstract: "Execute a command in a running VM", discussion: """
Requires Tart Guest Agent running in a guest VM.
Runs a command inside a running VM without SSH or guest networking.

Note that all non-vanilla Cirrus Labs VM images already have the Tart Guest Agent installed.
Requires macOS 14 or newer and Tart Guest Agent running inside the guest VM.
All non-vanilla Cirrus Labs VM images already include Tart Guest Agent.

Commands run directly as the guest user running Tart Guest Agent. Use a shell
explicitly for shell features such as pipes, redirection, or environment
variable expansion. Tart exits with the guest command's exit code.

Examples:
Run a command:
tart exec tahoe-base /usr/bin/uname -a

Run a shell command:
tart exec tahoe-base /bin/sh -c 'pwd; printenv HOME'

Open an interactive shell:
tart exec -i -t tahoe-base /bin/zsh

Run a local script inside the guest VM:
tart exec -i tahoe-base /bin/sh < script.sh

See https://github.com/openai/tart-guest-agent for guest agent installation
and execution privileges.
""")

@Flag(name: [.customShort("i")], help: "Attach host's standard input to a remote command")
Expand Down