Commands

auth login

Email a sign-in link and wait until it is opened, or until its one-time code is typed in

ledable auth login <email> [options]

Gives up after 600 seconds unless --timeout says otherwise.

auth accounts

List the accounts signed in on this machine and which one is current

ledable auth accounts [options]

Gives up after 30 seconds unless --timeout says otherwise.

auth use

Make another account signed in on this machine the current one

ledable auth use <user_id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

auth whoami

Show the current account's profile

ledable auth whoami [options]

Gives up after 30 seconds unless --timeout says otherwise.

auth logout

Sign out of the current account and clear its local credentials

ledable auth logout [options]

Gives up after 30 seconds unless --timeout says otherwise.

ble scan

Scan for LEDABLE devices nearby for 8 seconds, printing each one found

ledable ble scan [options]

Gives up after 30 seconds unless --timeout says otherwise.

ble info

Read a nearby device's model, hardware id and whether it is linked, without claiming it

ledable ble info <peripheral_id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

ble link

Run the app's pairing page: prints the devices nearby and the claim's progress

ledable ble link [options]

It reads one intent a line on stdin:

Gives up after 120 seconds unless --timeout says otherwise.

ble pair

Claim one nearby device through the pairing page and name it, ending with its device_id

ledable ble pair <peripheral_id> [options]

Gives up after 90 seconds unless --timeout says otherwise.

wifi setup

Run the app's Wi-Fi page over Bluetooth: prints the networks the device sees and knows

ledable wifi setup --device <id> [options]

It reads one intent a line on stdin:

Gives up after 120 seconds unless --timeout says otherwise.

wifi status

Read the device's Wi-Fi connection over Bluetooth

ledable wifi status --device <id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

wifi scan

Have the device scan for Wi-Fi networks

ledable wifi scan --device <id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

wifi known

Read the networks the device has saved, passwords left out

ledable wifi known --device <id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

wifi join

Join a network through the Wi-Fi page and wait for the device; hidden networks work too

ledable wifi join <ssid> --device <id> [options]

Gives up after 90 seconds unless --timeout says otherwise.

wifi forget

Forget a saved network through the Wi-Fi page; a device on it stays until it restarts

ledable wifi forget <ssid> --device <id> [options]

Gives up after 90 seconds unless --timeout says otherwise.

devices list

List the account's devices with their ids

ledable devices list [options]

Gives up after 30 seconds unless --timeout says otherwise.

devices info

Show one device's record

ledable devices info --device <id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

devices rename

Rename the device

ledable devices rename <nickname> --device <id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

devices remove

Unlink the device from the account

ledable devices remove --device <id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

devices ping

Ping the device and wait until it answers, which shows it is online

ledable devices ping --device <id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

devices presence

Run the app's presence watch: prints online or offline, the firmware version and what plays as they change

ledable devices presence --device <id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

devices logs

Stream the device's live log lines until the timeout

ledable devices logs --device <id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

devices logs-page

Run the app's log page: the stored window, live lines and the server's history

ledable devices logs-page --device <id> [options]

It reads one intent a line on stdin:

Gives up after 30 seconds unless --timeout says otherwise.

devices log-history

Query the device logs the server keeps

ledable devices log-history --device <id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

devices reboot

Restart the device

ledable devices reboot --device <id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

devices pull

Tell the device to read its configuration from the server again

ledable devices pull <app|device|all> --device <id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

store home

The store's home page: top apps per category, collections and the latest listings

ledable store home [options]

Gives up after 30 seconds unless --timeout says otherwise.

store search

Search the listed apps by name, description and tags

ledable store search <query> [options]

Gives up after 30 seconds unless --timeout says otherwise.

store app

An app's store page

ledable store app <app_id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

store manifest

A version's settings, each with its type, default and choices

ledable store manifest <app_id[@version]> [options]

Gives up after 30 seconds unless --timeout says otherwise.

store preview

Download a version's store preview as WebP, in the device's language and time zone when one is named

ledable store preview <app_id[@version]> <output> [options]

Gives up after 30 seconds unless --timeout says otherwise.

store install

Add an app to the device's playlist through the app's install page

ledable store install <app_id[@version]> --device <id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

store update

Move the playlist's entries of an app to the store's current version, keeping their settings

ledable store update <app_id> --device <id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

playlist list

Read the device's playlist

ledable playlist list --device <id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

playlist page

Run the app's playlist page: prints the entries as they change

ledable playlist page --device <id> [options]

It reads one intent a line on stdin:

Gives up after 300 seconds unless --timeout says otherwise.

playlist enable

Turn an entry's switch on

ledable playlist enable <instance_id> --device <id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

playlist disable

Turn an entry's switch off

ledable playlist disable <instance_id> --device <id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

playlist remove

Remove an entry; pictures no other entry shows are deleted with it

ledable playlist remove <instance_id> --device <id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

playlist move

Move an entry to another position

ledable playlist move <instance_id> <index> --device <id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

playlist rename

Rename a playlist entry

ledable playlist rename <instance_id> <name> --device <id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

playlist duration

Set how long a playlist entry shows

ledable playlist duration <instance_id> <seconds> --device <id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

playlist configure

Change a store app entry's settings through its settings page

ledable playlist configure <instance_id> --device <id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

playback control

Run the app's player: prints what the device plays as it changes

ledable playback control --device <id> [options]

It reads one intent a line on stdin:

Gives up after 30 seconds unless --timeout says otherwise.

playback toggle

Press the player's play/pause button; ends once the command is out, as older firmware reports no pause

ledable playback toggle --device <id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

playback next

Press the player's next button and wait for the device to follow

ledable playback next --device <id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

playback previous

Press the player's previous button and wait for the device to follow

ledable playback previous --device <id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

settings page

Run the app's device settings page: prints the settings as they change

ledable settings page --device <id> [options]

It reads one intent a line on stdin:

Gives up after 300 seconds unless --timeout says otherwise.

settings get

Read the language, time zone, brightness, display time and auto-update

ledable settings get --device <id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

settings language

Set the device's language

ledable settings language <tag> --device <id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

settings timezone

Set the device's time zone

ledable settings timezone <zone> --device <id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

settings duration

Set how long each playlist entry shows by default

ledable settings duration <seconds> --device <id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

settings auto-update

Turn automatic firmware updates on or off

ledable settings auto-update <on|off> --device <id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

settings brightness

Set the brightness, and how the light sensor adjusts it

ledable settings brightness <level> --device <id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

alarms list

Read the weekly alarm schedule

ledable alarms list --device <id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

alarms replace

Replace the whole alarm schedule

ledable alarms replace <file.json> --device <id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

alarms add

Add one alarm

ledable alarms add <second_of_week> --device <id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

alarms remove

Remove the alarms at one time of the week

ledable alarms remove <second_of_week> --device <id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

images convert

Turn a PNG, JPEG, WebP or GIF into the 64x32 WebP a device shows, keeping animation

ledable images convert <input> <output> [options]

Gives up after 30 seconds unless --timeout says otherwise. Works on this machine alone, with no account or network.

images add

Add an image to the device's playlist, as the app's Add a picture page does

ledable images add <input> --device <id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

images list

List the pictures stored for the device

ledable images list --device <id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

images download

Download a picture stored for the device

ledable images download <filename> <output> --device <id> [options]

Gives up after 30 seconds unless --timeout says otherwise.

firmware page

Run the app's firmware page: prints whether an update is available and each stage of one

ledable firmware page --device <id> [options]

It reads one intent a line on stdin:

Gives up after 600 seconds unless --timeout says otherwise.

auth-hub link

Link a third-party account in the browser, for the apps whose settings ask for one

ledable auth-hub link <github|todoist|google_youtube|spotify> [options]

Gives up after 600 seconds unless --timeout says otherwise.

auth-hub list

List the linked third-party accounts and their handles

ledable auth-hub list [options]

Gives up after 30 seconds unless --timeout says otherwise.

auth-hub remove

Forget a linked account; the service's authorisation stays until it is revoked there

ledable auth-hub remove <handle> [options]

Gives up after 30 seconds unless --timeout says otherwise.

developer init

Create an app project in a new directory and install its dependencies

ledable developer init <app_id> [options]

Gives up after 300 seconds unless --timeout says otherwise. Works on this machine alone, with no account or network.

developer check

Type-check the project in strict mode, as every build and upload does

ledable developer check [options]

Gives up after 30 seconds unless --timeout says otherwise. Works on this machine alone, with no account or network.

developer dev

Rebuild on every change and serve a preview page that runs each build as the gateway would

ledable developer dev [options]

Gives up after 86400 seconds unless --timeout says otherwise. Works on this machine alone, with no account or network.

developer set

Change the settings and device the running developer dev simulates, and print the render that follows

ledable developer set [options]

Gives up after 30 seconds unless --timeout says otherwise. Works on this machine alone, with no account or network.

developer render

Build once and write the image a device would get, or the store preview

ledable developer render [options]

Gives up after 300 seconds unless --timeout says otherwise. Works on this machine alone, with no account or network.

developer build

Build the bundle, its assets and the release manifest into a temporary directory, as an upload would

ledable developer build [options]

Gives up after 30 seconds unless --timeout says otherwise. Works on this machine alone, with no account or network.

developer create

Claim the project's app id for your account

ledable developer create [options]

Gives up after 30 seconds unless --timeout says otherwise.

developer upload

Build and upload the version ledable.json names; prints every publishing check

ledable developer upload [options]

Gives up after 300 seconds unless --timeout says otherwise.

developer versions

List the uploaded versions and their checks

ledable developer versions [options]

Gives up after 30 seconds unless --timeout says otherwise.

developer test

Show the version ledable.json names behind the app's share link

ledable developer test [options]

Gives up after 30 seconds unless --timeout says otherwise.

developer share

Print the app's share link

ledable developer share [options]

Gives up after 30 seconds unless --timeout says otherwise.

developer submit

Submit the version ledable.json names for review; official apps are listed at once

ledable developer submit [options]

Gives up after 30 seconds unless --timeout says otherwise.

developer withdraw

Take the submission waiting for review back

ledable developer withdraw [options]

Gives up after 30 seconds unless --timeout says otherwise.

developer unlist

Take the app out of the store; devices keep the versions they have, and a new submission lists it again

ledable developer unlist [options]

Gives up after 30 seconds unless --timeout says otherwise.

developer status

The listed and test versions, the submission under review, the latest review's decision and note, and whether the latest upload failed

ledable developer status [options]

Gives up after 30 seconds unless --timeout says otherwise.

secret set

Set one of the app's secrets, sealed on this machine; the value comes from a hidden prompt or one line of stdin

ledable secret set <NAME> [options]

Gives up after 30 seconds unless --timeout says otherwise.

secret list

List the app's secrets, the versions that declare each, and declared names without a value

ledable secret list [options]

Gives up after 30 seconds unless --timeout says otherwise.

secret delete

Delete one of the app's secrets that no published version declares

ledable secret delete <NAME> [options]

Gives up after 30 seconds unless --timeout says otherwise.