Files
umbrel-apps/README.md
nmfretz e0a982b877 Add agent-first app packaging guidance and linting
- Add agent-facing README, AGENTS.md, CLAUDE.md, and repo-local skills for packaging, updating, and testing apps
- Store skills in .claude/skills/ so Claude Code can discover them natively, while AGENTS.md keeps the same instructions reachable for Codex and other agents
- Add first-party app package linter with manifest, compose, image, port, persistence, and PR-output checks
- Add GitHub Actions lint workflow plus concise PR and issue templates for app submissions and package issues
2026-06-18 21:23:16 +10:00

1.7 KiB

Umbrel App Store Packages

This repository contains the app packages published in the official Umbrel App Store. Each top-level directory is an app package consumed by umbrelOS.

Browse the store at https://apps.umbrel.com.

Contributing

Before adding or updating app packages, read AGENTS.md.

AGENTS.md routes app packaging, updates, and testing to the repo-local skills in .claude/skills/. Those skills are the source of truth for packaging rules and verification steps.

App Store Standard

Every app package should open to a web UI, status page, or setup page that makes the app usable without SSH or CLI access.

Beyond that, apps should feel natural on umbrelOS: sensible defaults, browser-based setup, predictable updates, and careful handling of user data. Some apps need special setup or expose advanced controls, but the default path should be understandable from the browser.

App Store Badges

After an app is published, developers can use generated Umbrel App Store badges in their own README, website, or release notes.

App-specific badges, using Immich as an example:

Get Immich on umbrelOS Get Immich on umbrelOS

https://apps.umbrel.com/api/app/<app-id>/badge-dark.svg
https://apps.umbrel.com/api/app/<app-id>/badge-light.svg

Generic badges:

Get it on umbrelOS Get it on umbrelOS

https://apps.umbrel.com/badge-dark.svg
https://apps.umbrel.com/badge-light.svg