Vibe Desktop

FOR OPEN-SOURCE AUTHORS

One file. One topic. Installable everywhere.

Commit .vibedesktop/app.json to say how your project installs and which services it starts. Every Vibe Desktop can then install it with one click, run the frontend and backend as one app, and keep it healthy.

在仓库里放一个 .vibedesktop/app.json，再加一个 GitHub topic，你的前后端项目就能被所有 Vibe Desktop 一键安装。不需要账号，不需要表单。

  1. 01

    Describe your app

    List the install commands and the services with their ports. The first service is the page that opens.

    {
  "$schema": "https://vibedesktop.online/schema/app-v1.json",
  "schemaVersion": 1,
  "name": "Notes AI",
  "description": "Take notes and ask questions about them.",
  "icon": "icon.svg",
  "requires": ["node", "npm", "uv"],
  "setup": ["npm ci --prefix web", "uv sync --directory server --frozen"],
  "services": [
    { "name": "web", "cwd": "web", "run": "npm run dev -- --port $PORT", "port": 5173 },
    { "name": "api", "cwd": "server", "run": "uv run uvicorn app:app --port 8000", "port": 8000, "health": "/health" }
  ]
}

    Full format reference · JSON Schema

  2. 02

    Prove it runs

    check.py --run installs and starts the app exactly like the desktop, then checks every health path.

    TerminalPython 3, no dependencies
    curl -fsSL https://vibedesktop.online/skill.sh | sh && python3 ~/.claude/skills/vibedesktop-app/scripts/check.py . --run

    Using an AI agent? The same command installs the vibedesktop-app skill for Claude Code and Codex. Then ask: “Use vibedesktop-app to make this repository installable from the Vibe Desktop market and verify it.”

  3. 03

    Add the topic

    Push, then add the GitHub topic vibedesktop-app (repository → About → Topics). The market rebuilds every six hours and lists your app as Community.

    GitHub CLIoptional
    gh repo edit --add-topic vibedesktop-app

MARKET CHECK

See what the market sees

Checks your repository's default branch with the same validator the desktop uses. Runs in your browser against the public GitHub API.

REVIEWED BADGE

Want the Reviewed badge? Run the check above, then request a review of one exact commit.

A review covers a single commit, and the market installs that commit until the next review. Users always see the commands before anything runs, whatever the badge.