Skip to content
BobowskiPublic

About

Yard API and CLI. Slots, repos, and deploys.

Resources

Stars

3 stars

Watchers

0 watching

Forks

Repository files navigation

Yard

Push a repo to GitHub or Cursor Origin. Yard builds the container and serves the app over HTTPS.

Yard runs on one Ubuntu VM. It watches the forge, builds each push with Podman, and points Caddy at the new container. A git push is the whole deploy. There is no pipeline file and no dashboard.

Docs: stario.dev/yard

Quick start

On a fresh Ubuntu 26.04 LTS VM, as root, from a clone of this repo:

./install.sh --domain yard.example.com

The script prints an admin token. Then, on your laptop:

uv tool install staryard
yard login --url https://yard.example.com --token <token>
yard forge setup github          # or: yard forge setup origin

cd my-app
yard app new --public app.example.com
git push

The command is yard. The PyPI name is staryard, because yard is taken. Python 3.14 or newer is required.

What an app needs

  • Something Yard can build. That is a compose.yml with a service app on the network yard, or a Containerfile or Dockerfile at the repo root or in ops/. Or it is code that Yard knows, and Yard writes the Containerfile itself: Stario, Python (uv.lock or requirements.txt), Go, Node (npm), or http-nu.
  • A web process on port 8000.
  • Settings from the environment. yard env set KEY=VALUE writes them.
  • Persistent files in /data. That directory survives every deploy.

Yard runs any app in a container. A Stario app needs the least setup: no Containerfile. Yard sees stario in pyproject.toml, installs from uv.lock, starts python -m app.main, and sets STARIO_HOST=0.0.0.0. The deploy log names what Yard chose and why. When Yard is not sure, it stops and says what to add. How Yard reads a repo lists each file it reads. Any other app in a container works too, and so does software that someone else publishes: Self-host a service runs Vaultwarden from an image and Umami from a compose file, with no repo and no forge.

Docs

The docs at stario.dev/yard read as a short book:

  • The whole idea — Yard in one page: what each tool does and what Yard leaves out.
  • One push, start to finish — follow a single commit from your laptop to a live container.
  • Set up a host — a fresh VM to a working Yard in one script and a few commands.
  • Your first app — the four rules an app follows, then one push.
  • Self-host a service — run someone else's software from an image or a compose file, and what Yard does not do.
  • What an app runs — how Yard reads a repo, the Containerfile it writes for a Stario app, what it refuses, and how an app runs an image or a compose URL instead.
  • Day to day — logs, settings, domains, rollbacks, and cleanup.
  • Your own compose file — workers, sidecars, healthchecks, and apps in any language.
  • How it works — the internals: files, the check loop, the deploy container, Caddy, journald.
  • CLI, API, Glossary — the lookup pages.

Develop

uv run pytest
uv run python -m app.server.main
just check                       # ruff, format, pyright, pytest

The code layout is in AGENTS.md. Changes are in CHANGELOG.md.

About

Yard API and CLI. Slots, repos, and deploys.

Resources

Stars

3 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages