Documentation

What Ember is

One CLI for installing, publishing, tools, and Studio

Updated October 23, 2026

Installing Ember

GitHub releases, cargo, and getting ~/.ember/bin on PATH

Updated October 23, 2026

Quick start

From empty folder to require() in four commands

Updated October 22, 2026

CLI overview

Global behavior, exit codes, and every command

Updated October 23, 2026

embr init

Interactive manifest wizard

Updated October 22, 2026

embr add

Record a dependency, resolving before editing

Updated October 23, 2026

embr install

Install dependencies and tools, write the lockfile

Updated August 24, 2026

embr outdated

List the dependencies with a newer release

Updated October 23, 2026

embr patch

Edit a dependency's source and keep the edit

Updated August 24, 2026

embr publish

Pack, authenticate, and upload to the registry

Updated October 23, 2026

embr auth

Log in, log out, and show the stored login

Updated October 23, 2026

embr index

Manage named indices (wally, pesde, forest, custom)

Updated October 23, 2026

embr cache

Clear the archive and index caches

Updated August 24, 2026

embr tool

Pin GitHub-released binaries per project or globally

Updated August 24, 2026

embx

Run a released tool without installing it (embr execute)

Updated October 23, 2026

embr run

Project scripts, lists that run at once, and shortcuts

Updated October 22, 2026

embr studio

Describe and open what this project edits in Studio

Updated August 24, 2026

embr self

Manage the embr binary and set up editor IntelliSense

Updated October 23, 2026

embr mcp

Package search for coding agents, over MCP

Updated October 22, 2026

ember.toml at a glance

The whole manifest on one screen, table by table

Updated October 23, 2026

[package]

Name rules, versions, authors, repository, private

Updated October 22, 2026

[target]

Environments, language, fit rules, entry points, includes

Updated October 23, 2026

[dependencies] & [indices]

Dependency forms, version requirements, named indices

Updated October 23, 2026

[overrides]

Replace a dependency's dependency

Updated August 24, 2026

[patches]

Keep local edits to dependencies across installs

Updated August 24, 2026

[tools], [scripts] & [studio]

Pinned binaries, project scripts, and Studio targets

Updated October 22, 2026

[config]

Per-environment output folders and the require style

Updated October 22, 2026

Dependencies & installing

Resolution, the install layout, link files, lockfile

Updated October 23, 2026

Workspaces

One repository, many packages

Updated August 24, 2026

Publishing

Scopes, yanking, deprecation, logos, and authors

Updated October 23, 2026

Models in packages

Ship .rbxm models with your code, and the publish rules

Updated October 23, 2026

Runtimes

Roblox, Lune, Lute, Seal, Zune, and portable Luau

Updated October 22, 2026

Languages

Alloy, Loom, and Luwu packages, and Alloy projects

Updated October 23, 2026

Lifecycle hooks

pre/post scripts around your scripts and Ember commands

Updated August 24, 2026

Files & locations

What Ember writes where, and exit codes

Updated October 23, 2026

Registry & endpoints

The CDN, the API, and the public index

Updated October 23, 2026

Playground

Run Luau and Alloy in the browser, and try packages

Updated October 23, 2026

Sharp edges

Behavior that surprises people, collected

Updated October 22, 2026