Skip to content

Latest commit

 

History

History
71 lines (52 loc) · 2.34 KB

README.md

File metadata and controls

71 lines (52 loc) · 2.34 KB
Raw
World CLI Logo

A swiss army knife for creating, managing, and deploying World Engine projects

Codecov Go Report Card Telegram Chat Twitter Follow

Overview

Key features:

  • Create — Initialize a new World Engine project based on starter-game-template
  • Dev Mode — Run your game shard in dev mode (with editor support) for fast iteration
  • [Soon] Deploy — Get a prod-ready World Engine deployment in the cloud easier than deploying a smart contract.

Need help getting started with World Engine? Check out the World Engine docs!


Installation

World CLI has been rigorously tested on macOS and Linux. If you are using Windows, you will need WSL to install and use the CLI.

Install latest release:

curl https://install.world.dev/cli! | bash

Install a specific release:

curl https://install.world.dev/cli@<release_tag>! | bash

Development

This section is for devel developers who want to contribute to the World CLI. If you want to develop a World Engine project using World CLI, see the World Engine quickstart guide

Building from source:

make build

Testing your local build:

You can test your local build of World CLI by running the following command. This will install the World CLI binary in your /usr/local/bin directory.

make install