CLI commands

This page is a quick map of the most common commands. Run niblet --help or niblet <command> --help for every option supported by your installed version.

Use CLI v0.54.9 or newer for the display commands and apps install below. Run niblet update if you have an older version.

Hosted apps

Command	Result
`niblet apps init [DIRECTORY]`	Create a project with `manifest.yaml` and `main.star`
`niblet apps validate [PATH]`	Check the project and run a bounded local render
`niblet apps preview [PATH] -o FILE`	Save a local WebP preview
`niblet apps preview [PATH] --device DEVICE_ID`	Show the local preview on your display for five minutes
`niblet apps push [PATH]`	Upload a new immutable source-and-preview revision
`niblet apps install REVISION_ID --device DEVICE_ID`	Install your private app without submitting it for review
`niblet apps submit REVISION_ID`	Send an uploaded revision for review
`niblet apps list`	List your hosted developer projects
`niblet apps secrets list [PATH]`	Show publisher credential status without revealing values
`niblet apps secrets set FIELD [PATH]`	Set a declared publisher credential using a hidden prompt
`niblet apps secrets delete FIELD [PATH]`	Delete a declared publisher credential

Local runtime

Command	Result
`niblet serve PATH`	Open a live browser preview
`niblet render PATH`	Save an app as WebP or GIF
`niblet check PATH`	Run compatibility, formatting, and render checks
`niblet format PATH`	Format Starlark source
`niblet lint PATH`	Report lint findings
`niblet profile PATH`	Find expensive Starlark functions
`niblet schema PATH`	Evaluate the app’s settings schema

Account and display

Command	Result
`niblet auth login`	Sign in through the browser
`niblet auth logout`	Revoke and clear the CLI session
`niblet devices`	List display IDs and names for the signed-in account
`niblet list DEVICE_ID`	List installation IDs and app handles on a display
`niblet push DEVICE_ID main.star`	Render locally and show a five-minute preview
`niblet push DEVICE_ID preview.webp`	Show an already rendered WebP for five minutes
`niblet delete DEVICE_ID INSTALLATION_ID`	Remove an installation from that display

apps preview --device requires CLI v0.54.8 or newer. If your installed version reports an unknown flag, run niblet update and check niblet version. A device preview sends a 64×32 WebP, never source code, to Cloud. If a device returns 404, check the CLI’s configured API URL and sign in with the same account that owns it in the dashboard. A device ID from another account is intentionally unavailable. Find IDs with niblet devices on v0.54.9 or newer, or the device parameter in the dashboard URL on v0.54.8. The old push --installation-id and --background options are retired. For an app that stays in your rotation and refreshes its data, upload it with niblet apps push ., then use niblet apps install REVISION_ID --device DEVICE_ID. Use the returned installation ID with niblet delete when you want to remove it.

CLI maintenance

Command	Result
`niblet version`	Show the installed CLI version
`niblet update`	Install the latest checksum-verified stable release

Niblet CLI

Niblet MCP

Hosted apps

Local runtime

Account and display

CLI maintenance

​Hosted apps

​Local runtime

​Account and display

​CLI maintenance

Hosted apps

Local runtime

Account and display

CLI maintenance