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

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.

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.0.tar.gz (68.6 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.0-py3-none-any.whl (31.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: runbuoy-0.1.0.tar.gz
  • Upload date:
  • Size: 68.6 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.0.tar.gz
Algorithm Hash digest
SHA256 267a958d53b8f2b3a5d470cf19e2736adc6f6261ad559a37552598accace0bb1
MD5 69dbdc6998cd9992860c7201e17a5633
BLAKE2b-256 8ce481782b317f4867a2de02b2392da4f9ea3bc7b5fac1c695d93adc39e6373e

See more details on using hashes here.

Provenance

The following attestation bundles were made for runbuoy-0.1.0.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.0-py3-none-any.whl.

File metadata

  • Download URL: runbuoy-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 31.8 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cd79ffdb20ce617e76617077bd9af485e1d4e3de8fbd6576a6420268ce540d06
MD5 15e0ea1d432b2d25d0ede62afbc11a53
BLAKE2b-256 f4159ff30d990a5eacc8d18129bcf8bb7a91dbfa129e26e4ba8e20b0975ed744

See more details on using hashes here.

Provenance

The following attestation bundles were made for runbuoy-0.1.0-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