CLI Reference

rebind is the command-line companion to the Rebind app: scaffold a package, validate and lint it offline, run it against your local Rebind app with live logs and hot-reload, then package and publish it. It installs with Rebind and lands on your PATH, with no separate download. check, lint, new, package, and preview work fully offline. run, exec, repl, whoami, publish, import, export, and ui talk to the Rebind app, so it must be running (and signed in, for whoami/publish).

Commands

rebind new <name>      scaffold a package                 (alias: n)
rebind check [path]    validate a package or script       (alias: c)
rebind lint [path]     lint the require graph             (alias: l)
rebind run [path]      run via the Rebind app             (alias: r)
rebind exec <code>     one-off chunk in Rebind            (alias: x)
rebind repl            interactive session
rebind package [path]  build the .rbp archive             (alias: p)
rebind publish [path]  upload for marketplace review
rebind preview [path]  preview the marketplace listing locally
rebind import <file>   install a .rbp package             (alias: i)
rebind export <path>   build a .rbp package               (alias: e)
rebind whoami          session, device, transport         (alias: w)
rebind ui              open the control panel as an app window

Every [path] defaults to the current directory and accepts either a package directory or a single .lua/.luau file.

new

$ rebind new hello
created hello/
  rebind.toml  main.luau  README.md  .gitignore

next: cd hello && rebind run

The package name is the final path component (rebind new tools/hello creates a package named hello), lowercased. The scaffolded rebind.toml carries a commented-out [marketplace] block (summary, category, icon, media, and [marketplace.price]). The README.md ships inside the .rbp and becomes the listing’s overview when you publish.

check

Offline validation of the package contract: manifest schema and pricing rules, identity declarations, the full require graph, Luau compilation of every reachable module, and a permission audit. The audit covers the two permissions the runtime enforces, net (Net.*) and exec (System.Exec, System.ExecDetached). It compares uses against the entry modeline, so a script that declares exec and forgets net fails here instead of at runtime. Undeclared means all permissions, so for a script that declares none there is nothing to contradict and the comparison is inert. A package carrying a [marketplace] block is held to more: publish refuses an undeclared set, so check fails it here rather than at upload. The audit lexes the source, so a mention inside a string or comment is not a call, but it does not resolve aliases (local n = Net; n.Get()).

$ rebind check
checking hello v0.0.1
ok  manifest · modeline · require graph (1 module) · compile · permissions

Checking a script that lives inside a package shows its container:

$ rebind check scripts/wiggle.luau
checking wiggle (in hello v0.0.1)
ok  modeline · require graph (1 module) · compile · permissions

lint

Advisory linting over the same require graph, with the Rebind standard library preloaded so HID, Log, hooks, and the rest of the SDK resolve. Warnings never block anything; error-severity findings (definite bugs) exit non-zero and block publish.

$ rebind lint
linting hello
warning: dx is assigned a value, but never used
  --> main.luau:2
lint: 1 warning, 0 errors

run

The dev loop: validates, loads the entry into the running Rebind app, streams the script’s log channel, and hot-reloads when a source file changes.

$ rebind run
checking hello v0.0.1
ok  manifest · modeline · require graph (1 module) · compile · permissions

01:30:03  info   Script started
01:30:03  info   hello started
01:30:08  ⟳ reloaded (main.luau changed)

Only this script’s lines appear: its own Log.* output plus Rebind’s lifecycle notices and errors for it. --all-logs streams every Rebind log line (prefixed with its source) for app-wide debugging. Edits to .lua/.luau/ .toml files and anything under assets/ trigger a reload; a failing re-check keeps the previous run alive. rebind run scripts/wiggle.luau runs a single script from a package’s scripts/ directory. It inherits the package’s min_sdk, and its requires resolve from the package root.

exec and repl

Both run chunks in a persistent scratch runtime inside the Rebind app: the full SDK with real input output, state surviving between calls.

$ rebind exec 'HID.MoveTo(500, 500) local w,h=System.Screen() print(w,h)'
2560	1440
$ rebind x 'foo = 19'
$ rebind x 'return foo + 23'
42

rebind exec - reads the chunk from stdin. A Lua error exits non-zero. rebind repl is the interactive version: same runtime, TAB completion queried live from the VM (your own variables complete, not just SDK names), and unfinished chunks continue on the next line. ⌃D exits.

package

Builds the .rbp registry artifact, a gzipped tarball of the package’s plaintext source and assets. Format details are in Package format.

$ rebind package
…check output…
packaged hello.rbp (3 files, 1.2 KB)

--out <path> sets the output file. The default is <slug>.rbp in the current directory.

publish

The script marketplace has not been released yet. Publishing requires a Developer account, which is not yet publicly available.

Check → lint → package → upload for review. Error-severity lint findings block the upload; warnings do not. Requires:

a package (rebind.toml); a bare script has no listing to publish
a Developer account with a claimed @handle
a [marketplace] section with summary and category
a [marketplace.price] table for a paid listing; omit it for a free listing
at least one screenshot .png in media; the first png becomes the cover
an optional 128x128 icon, separate from the cover and gallery

The Rebind app’s authenticated session does the uploading; the CLI holds no credentials. The .rbp goes up first, followed by the cover, optional icon, and remaining gallery items in declaration order. A README.md at the package root is sent as the listing’s overview; without one the product page falls back to summary.

$ rebind publish
…check + lint output…
packaged hello.rbp (3 files, 1.2 KB)
overview README.md

preview

Loads the package manifest and opens a self-contained local HTML approximation of its marketplace listing. It reads only rebind.toml, README.md, and local media. No sign-in or running Rebind app is required.

rebind preview

The preview surfaces missing or invalid listing fields, but it is not the store UI. Run rebind check before publishing for the complete package validation.

import and export

import installs a .rbp into the Rebind app’s scripts tree, under scripts/packages/<name>/, with the name taken from the archive’s rebind.toml. --overwrite replaces an existing install of the same package.

$ rebind import hello.rbp
imported hello → packages/hello (3 files)

export is the inverse: it builds a .rbp from something already installed. The path is relative to the scripts root. --out <path> sets the output file.

$ rebind export packages/hello
exported hello.rbp (1.2 KB)

whoami

$ rebind whoami
@you  you@example.com
tier       developer
mcid       MCID_E90400001E341DE5DA83E393AA1B4035 (not attached)
transport  software

mcid is your registered Rebind Link with its live attachment state; transport is the session mode (hardware when your device drives output, software otherwise).

ui

Opens the Rebind control panel as its own window, using an installed Chromium browser’s app mode. With no Chromium browser, or with the app not yet answering, it opens an ordinary browser tab instead. --url defaults to http://127.0.0.1:19480 and must stay on loopback: the app’s WebSocket guard only accepts localhost, 127.0.0.1, and ::1 origins.

Getting Started

Concepts

Cookbook

Reference

Remote Control

Help

Commands

new

check

lint

run

exec and repl

package

publish

preview

import and export

whoami

ui

​Commands

​new

​check

​lint

​run

​exec and repl

​package

​publish

​preview

​import and export

​whoami

​ui

Commands

new

check

lint

run

exec and repl

package

publish

preview

import and export

whoami

ui