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

  • A Containerfile or Dockerfile at the repo root or in ops/. Or a compose.yml with a service app on the network yard.
  • 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 is built for Stario apps, but it never looks inside the image. Any app in a container works.

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.
  • What an app runs — a Containerfile, a compose file, an image, or a recipe: how Yard picks and how you change it.
  • 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