Skip to content
core-red-projectPublic

About

A zero-dependency CLI that brings reliable workflows to offline Raspberry Pi environments. One binary. No network. No surprises.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

2 stars

Watchers

0 watching

Forks

Repository files navigation

Orph

Banner

Version MSRV License CI

Offline-first ✦ Zero dependencies ✦ Built for constrained hardware
On-device Raspberry Pi Harness. One binary. No network. No noise.

About ✦ Features ✦ Installation ✦ Usage ✦ Architecture ✦ Contributing


About

Orph is a local harness for Raspberry Pi and other offline, resource-constrained devices. It standardizes on-device workflows — script execution, config management, system inspection — without requiring a network, a package manager, or anything beyond the binary itself.

Fresh Pi. No network. No packages. You need to inspect the system, run scripts, persist state — without installing anything first. That's where Orph lives. Drop the binary, run it. Zero runtime dependencies means an entire class of problems just doesn't exist.

It ships as two binaries: orph (the CLI) and orphd (an optional background daemon). Everything lives in standard XDG locations — config in ~/.config/orph/, data in ~/.local/share/orph/, logs in ~/.local/state/orph/. No external calls. No cloud. No surprises.

Philosophy

"Local-first. No external services. No dependencies beyond the binary."

This is a Core Red Project, part of the Sxnnyside Project's experimental branch.

Features

  • Script runner: Standardize workflows from $XDG_DATA_HOME/orph/scripts/ with timeouts, captured output, and path safety.
  • Local config store: Plain config.toml in $XDG_CONFIG_HOME/orph/, managed via orph cfg. Hand-editable, no daemon required.
  • Optional daemon (orphd): Unix socket server for persistent state across rapid invocations, with silent local fallback.
  • System inspection: Instant CPU, memory, disk, and host info via orph sys and orph health.
  • Interactive TUI: Terminal dashboard (orph island) with hardware diagnostics (F3) and execution history (F6).
  • Local telemetry: Command usage tracking in $XDG_DATA_HOME/orph/orph.db with configurable retention limits. Never transmitted.
  • Shell completions & man page: Native completions for Bash, Zsh, and Fish, plus generated UNIX man pages.
  • Virtual pet: An interactive, time-decaying companion living in your terminal via orph pet.

Installation

Prerequisites

From a Release (Debian / Raspberry Pi OS, ARM64)

curl -LO https://github.com/core-red-project/orph-cli/releases/latest/download/orph-cli_1.0.0-1_arm64.deb
sudo dpkg -i orph-cli_*.deb

Installs both binaries, the man page (man orph), and the systemd user service.

From Source

git clone https://github.com/core-red-project/orph-cli.git
cd orph-cli

just build
just install-bin

Cross-compilation (Raspberry Pi 5)

just cross
# copy target/aarch64-unknown-linux-gnu/release/{orph,orphd} to your Pi

Usage

# system inspection
orph sys status
orph sys info

# script runner (scripts live in $XDG_DATA_HOME/orph/scripts/)
orph run list
orph run hello --timeout 30

# config management
orph cfg list
orph cfg get <key>
orph cfg set <key> <value>

# logs
orph logs                   # view all
orph logs -n 20             # last 20 lines
orph logs -f                # stream live logs

# optional daemon lifecycle
orph core start             # start orphd in background
orph core status            # check status
orph core stop

# local telemetry
orph telemetry
orph telemetry top

# interactive TUI dashboard
orph island

# virtual pet
orph pet
orph pet feed
orph pet play

# shell completions
orph completions zsh >> ~/.zshrc

Architecture

orph-cli/
├── src/cli/       # Argument parsing and global output flags (clap)
├── src/commands/  # Subcommand handlers (sys, run, cfg, logs, pet, etc.)
├── src/daemon/    # Optional Unix-socket background daemon (orphd)
├── src/models/    # Shared domain data types and diagnostics models
├── src/services/  # SQLite storage, telemetry, paths, and script runner
└── src/tui/       # Orph Island interactive terminal user interface

Contributing

Contributions are accepted. See CONTRIBUTING.md for guidelines.

Before contributing, read the Code of Conduct.

License

This project is licensed under the MIT License — see the LICENSE file for details.


Orph — A Core Red Project
© 2026 Sxnnyside Project

About

A zero-dependency CLI that brings reliable workflows to offline Raspberry Pi environments. One binary. No network. No surprises.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages