Skip to Content
Docs

app.json

Every field and its rule.

View as Markdown

Every app has an app.json at the top of its folder. $schema is https://0x1audio.com/schema/app/v1.json; editors use it for autocomplete. Unknown fields are errors. mixel check applies these rules, and so do Mixel and the registry.

FieldRule
$schemarequiredAlways this URL. It says the file is app.json v1.
namerequiredThe app's id: lowercase letters, digits and dashes. Never changes.
displayNamerequiredThe name people see.
summaryoptionalOne sentence about what the app does, for the catalog.
versionrequiredMAJOR.MINOR.PATCH. Raise it before each release.
sdkrequiredThe Mixel versions the app runs on, as a caret range like ^0.3.
entryentry or pageThe Python file with the app's @ox.action functions.
pageentry or pageAn optional page, built by Vite.
permissionsoptionalWhat the app may use, each with the reason the person reads. Binding: anything else is refused.
accentoptionalThe app's colour, like #5b8cff.
iconoptionalA square .svg or .png inside the app.
windowoptionalThe size the app's window opens at, in pixels.
tagsoptionalUp to 5 words for the catalog, like "convert".
licenseoptionalThe app's licence, an SPDX identifier like "Apache-2.0". mixel new writes Apache-2.0; change it if you choose another.

Window sizes in pixels: width 400–2560, height 320–1600, minWidth 400–2560, minHeight 320–1600. Reasons are 12 to 120 characters.