An open API service indexing awesome lists of open source software.

https://github.com/argus-labs/world-cli

A swiss army knife for creating, managing, and deploying World Engine projects
https://github.com/argus-labs/world-cli

cli world-engine

Last synced: about 2 months ago
JSON representation

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

Awesome Lists containing this project

README

          


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](https://github.com/Argus-Labs/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](https://world.dev)!


## Installation

World CLI has been rigorously tested on macOS and Linux.
If you are using Windows, you will need
[WSL](https://docs.microsoft.com/en-us/windows/wsl/install-win10) to install and use the CLI.

**Install latest release:**

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

**Install a specific release:**

```shell
curl https://install.world.dev/cli@! | 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](https://world.dev/quickstart)

**Building from source:**

```shell
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.

```shell
make install
```