Skip to content

docs: point World CLI users to world-engine #257

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
smsunarto merged 1 commit into from
Sep 29, 2026
Merged

docs: point World CLI users to world-engine #257

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# World CLI (deprecated)

World CLI now lives in [argus-labs/world-engine](https://github.com/argus-labs/world-engine/tree/main/cli)
and ships as a Go tool inside the World Engine module, so a game's CLI is always the same version as
its World Engine. This repository no longer receives releases, and the `install.world.dev` install
scripts are deprecated. You need Go 1.27.1 or later.

Install the `world` command and create a project:

```sh
go install github.com/argus-labs/world-engine/cli/cmd/world@latest
world setup my-game
```

Inside a project, `world` runs the version the project pins. To add World CLI to an existing game at
its current World Engine version:

```sh
go mod edit -tool=github.com/argus-labs/world-engine/cli/cmd/world
go mod tidy
```

The binaries attached to past [releases](https://github.com/Argus-Labs/world-cli/releases) stay
available for projects pinned to them. The source in this repository predates World CLI v2 and is
not maintained.
Loading