v1.2.0

CLI Reference

The UrsaMU CLI requires no install — run it directly from JSR with deno run.

Running the CLI

deno run -A jsr:@ursamu/ursamu/cli <command> [options]

Or install it locally for convenience (see install-cli).

create

Scaffold a new game project or plugin.

New game project

deno run -A jsr:@ursamu/ursamu/cli create <project-name>

Creates a new directory with a fully-configured UrsaMU game project:

  • src/main.ts — entry point
  • src/plugins/ — plugin directory (auto-discovered)
  • system/scripts/ — local script overrides
  • config/config.json — server configuration
  • deno.json — Deno project file

In-tree plugin (inside an existing project)

deno run -A jsr:@ursamu/ursamu/cli create plugin <name>

Run from your game project root. Generates src/plugins/<name>/ with:

  • index.ts — plugin definition (IPlugin)
  • commands.ts — command registrations
  • README.md — plugin documentation stub

Standalone publishable plugin

deno run -A jsr:@ursamu/ursamu/cli create plugin <name> --standalone

Generates a self-contained plugin repo at ./<name>/ ready for publishing to JSR or GitHub.

plugin

Manage the plugin registry (src/plugins/plugins.manifest.json).

List installed plugins

deno run -A jsr:@ursamu/ursamu/cli plugin list

Install a plugin

deno run -A jsr:@ursamu/ursamu/cli plugin install <github-url>

Adds the plugin to the manifest and downloads it into src/plugins/.

Pin to a specific tag or commit:

deno run -A jsr:@ursamu/ursamu/cli plugin install <github-url> --ref v1.2.0

Update a plugin

deno run -A jsr:@ursamu/ursamu/cli plugin update <name>

Fetches the latest ref for the plugin and updates the manifest.

Remove a plugin

deno run -A jsr:@ursamu/ursamu/cli plugin remove <name>

Removes the plugin from the manifest and deletes its directory.

Show plugin info

deno run -A jsr:@ursamu/ursamu/cli plugin info <name>

Displays metadata, installed version, and available update.

update

Update the UrsaMU engine in an existing game project.

deno run -A jsr:@ursamu/ursamu/cli update

Preview changes without writing:

deno run -A jsr:@ursamu/ursamu/cli update --dry-run

config

Print the current server configuration:

deno task config

install-cli

Install the CLI as a local binary so you don’t need the full deno run invocation:

deno task install-cli

After install:

ursamu create my-game
ursamu plugin list