Skip to main content

Read-only command status delivery for RunBuoy

Project description

RunBuoy CLI

RunBuoy keeps long-running commands visible from an iPhone without exposing a remote-control surface. The CLI runs commands locally, records structured status and progress, and sends a deliberately limited projection to a paired RunBuoy server.

Requirements

  • macOS or Linux
  • Python 3.12 or newer
  • tmux for durable runs

Install tmux before RunBuoy:

# macOS
brew install tmux

# Debian or Ubuntu
sudo apt install tmux

Install

Install the CLI in an isolated environment with uv:

uv tool install runbuoy

Or use pipx:

pipx install runbuoy

The installed executable is available directly:

runbuoy doctor
runbuoy capabilities --json

New installations use https://runbuoy.cloud as the default server URL. Override it when needed with runbuoy config --server-url <url>.

Upgrade with the same tool used for installation:

uv tool upgrade runbuoy
# or
pipx upgrade runbuoy

Quick start

Pair this machine with the RunBuoy iOS app:

runbuoy pair

Run a command:

runbuoy run -- python3 experiment.py

Send a notification without starting a managed run:

runbuoy notify \
  --title "Build completed" \
  --body "Release build succeeded" \
  --level success

RunBuoy does not upload full command arguments, working directories, environment variables, source code, or complete logs by default. See the security documentation for the complete data boundary.

Source and support

Source code, documentation, and issue tracking are available in the RunBuoy repository. Maintainer packaging and release instructions are in docs/cli-distribution.md.

RunBuoy is licensed under the MIT License.

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

runbuoy-0.1.1.tar.gz (68.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

runbuoy-0.1.1-py3-none-any.whl (31.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: runbuoy-0.1.1.tar.gz
  • Upload date:
  • Size: 68.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for runbuoy-0.1.1.tar.gz
Algorithm Hash digest
SHA256 4734c8a57d48e7795705b01273f9e21099399dcc624a19047c31510cd06497be
MD5 a267f500ccb491c2476f552373c78014
BLAKE2b-256 5c43d0035fd2158239befe2523e9f27614255d53957f00c350d85b528431b6dd

See more details on using hashes here.

Provenance

The following attestation bundles were made for runbuoy-0.1.1.tar.gz:

Publisher: publish-cli.yml on TANG617/RunBuoy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: runbuoy-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 31.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for runbuoy-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9108609a6bd5cd70902267145e4f6e2ac0af6a894b56662c75783602ef47abca
MD5 25efac79ab68d12cce2ab6d343bec496
BLAKE2b-256 919d838911da0e607b242c4013652c22130fdaea7422cd71b87a806c0b6c1670

See more details on using hashes here.

Provenance

The following attestation bundles were made for runbuoy-0.1.1-py3-none-any.whl:

Publisher: publish-cli.yml on TANG617/RunBuoy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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