Reference
ledable.json
Every field of a project’s ledable.json.
On this page
ledable.json sits at the root of every app project. The CLI checks it against these fields before every build, and the store checks each upload again; a field not listed here is refused. The project shows a whole file.
app_idstring · required
The app's id in the store: lowercase letters, digits and hyphens, starting with a letter or a digit, at most 64 characters. It is claimed once with ledable developer create and never changes.
versionstring · required
The version this project builds, as major.minor.patch with an optional pre-release suffix, such as 1.2.0 or 1.2.0-beta.1. An upload publishes the version named here, and a published version never changes.
namestring · required
The app's name in the store.
At most 30 characters.
descriptionstring · required
One line that sums the app up, shown with its name.
At most 120 characters.
websiteURL · optional
A web page about the app, as a full URL.
contactstring · optional
How people reach you about the app, such as an e-mail address.
tagsstring[] · optional
Words people may search the store for, each listed once.
At most 5 tags, each at most 20 characters.
secretsstring[] · optional
The names of the secrets the app reads: capitals, digits and underscores, not starting with a digit. Their values are set with ledable secret set, never written here.
categorystring · required
The store category the app is listed in.
One of clock, weather, finance, news, sports, productivity, developer, entertainment, science, travel.
networkobject · required
What the app may reach on the network.
network.allowed_hostsstring[] · required
Every host the app requests, each listed once: a host name such as api.example.com, or *. and a domain for its subdomains at any depth but not the domain itself. A wildcard over a public suffix, such as *.com or *.github.io, is refused. Requests go over HTTPS on the default port only. An app that uses no network lists none.
entrystring · required
The module whose default export is the app's defineApp, relative to the project's folder.
readmestring · optional
A Markdown file of the project that the store shows as the app's page.
The file holds at most 4000 characters.
iconobject · optional
The app's icon in the store.
icon.pathstring · required
A file of the project, relative to its folder.
screenshotsobject[] · optional
Pictures of the app on a display, shown on its store page in this order.
At most 6 screenshots.
screenshots[].pathstring · required
A file of the project, relative to its folder.