CLI reference

ase sdk

The selected engine SDK: develop it here, or install and update it in a game.

ase sdk download

Cache one engine's selected SDK components without installing them.

Requires: a sign-in (ase login) or, in CI, a release credential.

Changes: Caches the SDK on this machine. In a configured project it also writes .gitignore and .ase/sdk-resolution.json; it never touches the SDK folder.

ase sdk download [OPTIONS]

Argument	Description
`--engine <ENGINE>`	The engine whose SDK to cache; the project's by default.
`--version <VERSION>`	A specific release; the newest by default.
`--target <TARGET>`	Also the SDK's native components for this platform target, e.g. `android-arm64`.
`--project <PROJECT>`	The engine project's folder. Default `.`.
`--offline`	Use only this machine's SDK cache; download nothing.

ase sdk install

Install this project's configured SDK; latest is the default policy.

Requires: a sign-in (ase login) or, in CI, a release credential.

Changes: Installs the SDK into the project: the engine's SDK folder (addons/ase_brain, Packages/dev.asegames.brain or Plugins/AseBrain), brain/project.toml, .gitignore and .ase/, and for Godot project.godot and the export presets. It refuses when a file it manages was edited, and keeps other files it replaces in .ase/sdk-backup-*.

ase sdk install [OPTIONS]

Argument	Description
`--game <GAME>`	The game's id in the registry.
`--version <VERSION>`	A specific release; the project's policy by default.
`--target <TARGET>`	Also the SDK's native components for this platform target, e.g. `android-arm64`.
`--project <PROJECT>`	The engine project's folder. Default `.`.
`--offline`	Use only this machine's SDK cache; download nothing.

ase sdk migrate

Switch a vendored project to latest and untrack its SDK, preserving local files.

Requires: a sign-in (ase login) or, in CI, a release credential. git, in a git repo.

Changes: Writes brain/project.toml, .gitignore and .ase/sdk-resolution.json, and untracks the vendored SDK in git's index (git rm --cached); its files stay on disk, and git restore --staged tracks them again.

ase sdk migrate [OPTIONS]

Argument	Description
`--project <PROJECT>`	The engine project's folder. Default `.`.
`--offline`	Use only this machine's SDK cache; download nothing.

ase sdk build

Build the selected package SDK for this machine or a requested target (in ase-brain).

Requires: a sign-in (ase login) or, in CI, a release credential. An ase-brain checkout, and Rust's cargo.

Changes: Build output under the checkout's target/, and for Godot the sandbox's native-policy.json.

ase sdk build [OPTIONS]

Argument	Description
`--release`	Build with Cargo's `release` profile.
`--profile <PROFILE>`	Cargo's profile (`dev`, `release`, `dist`); `--release` is `release`.
`--target <TARGET>`	A phone's library: android-arm64, android-x86_64 (needs the Android NDK) or ios-arm64 (needs Xcode).

ase sdk check

Build and check the SDK with the selected engine package (in ase-brain).

Requires: a sign-in (ase login) or, in CI, a release credential. An ase-brain checkout, Rust's cargo, and Godot in GODOT to run the sandbox.

Changes: Build output under the checkout's target/, and the Godot sandbox's native-policy.json and import files.

ase sdk check [OPTIONS]

Argument	Description
`--prebuilt`	Check the packaged SDK without replacing its native library with a local build.

ase sdk update

Install or update the SDK in a game's engine project.

Requires: a sign-in (ase login) or, in CI, a release credential.

ase sdk update [OPTIONS]

Argument	Description
`--game <GAME>`	The game's id in the registry; the engine package owns its SDK wiring.
`--version <VERSION>`	A specific release, e.g. 0.2.0; the newest by default.
`--target <TARGET>`	Also the SDK's native components for this platform target, e.g. `android-arm64`.
`--offline`	Use only this machine's SDK cache; download nothing.
`--project <PROJECT>`	The project repository; the current directory by default. Default `.`.

Examples

ase sdk update
ase sdk update --version 0.2.0

ase sdk status

Show the installed SDK version against the selected package.

Requires: nothing from ASE Brain; it runs signed out.

Changes: nothing; it only reads.

ase sdk status [OPTIONS]

Argument	Description
`--project <PROJECT>`	The engine project's folder. Default `.`.

Examples

ase sdk status

ase sdk ensure

Install a missing SDK or report a waiting update as one JSON line; engine loaders call this when an editor opens.

Requires: a sign-in (ase login) to download an SDK; signed out or offline it uses the SDK already on this machine.

Changes: Installs a missing or outdated SDK as ase sdk install does; with --editor and an SDK in place it only reports the update. It writes .gitignore and .ase/sdk-resolution.json when it checks for one.

ase sdk ensure [OPTIONS]

Argument	Description
`--project <PROJECT>`	The engine project's folder. Default `.`.
`--editor`	An editor has the project open, so its loaded SDK is never replaced.
`--no-check`	Skip the update check while a verified SDK is installed (build hooks).
`--loader <LOADER>`	The loader's protocol version. Default `1`.
`--offline`	Use only this machine's SDK cache; download nothing.

Examples

ase sdk ensure --editor

ase sdk apply

Install the SDK after an editor exits, then start the command after -- if given.

Requires: a sign-in (ase login) to download an SDK; signed out or offline it uses the SDK already on this machine.

Changes: Waits for the editor to exit, installs the SDK as ase sdk install does, then starts the command after --.

ase sdk apply [OPTIONS] [-- <RELAUNCH>...]

Argument	Description
`--project <PROJECT>`	The engine project's folder. Default `.`.
`--wait-pid <WAIT_PID>`	The editor process to wait for.
`-- <RELAUNCH>...`	The editor command to start once the SDK is installed.

Examples

ase sdk apply --wait-pid 4242 -- godot --editor --path .