Installation

Installing the Venus CLI is simple. It works on any modern Mac, Windows, or Linux desktop machine.

MacOS / Linux

1

Open a Terminal

You can find the terminal app in the Applications/Utilities folder. Or, press Cmd + Space Bar and type terminal to search for it.

Linux users, you know where to find it. 😉

2

Run the install script

Copy the following line:

curl -fsSL https://github.com/series-ai/venus_cli_releases/releases/latest/download/install.sh | bash

Paste the line into the Terminal and press enter., then give it a few seconds to install.

3

Restart the Terminal app

Don't skip this step! Quit the Terminal app and restart it. Restarting it allows Terminal to find the Venus CLI app.

4

Verify installation

To ensure the Venus CLI was successfully installed on your computer, type this in your terminal and hit enter. You should see a list of commands.

venus --help

Windows

1

Open PowerShell

If you've never opened PowerShell, it's easy. Tap the Start key to open the Start menu, type "PowerShell", and you'll see the app show up in search results. If you don't see it:

• Press Windows key + Q

• Type powershell into the Search dialog box and click to open.

2

Run the install script

Copy the following line:

irm https://github.com/series-ai/venus_cli_releases/releases/latest/download/install.ps1 | iex

Paste the line into the Terminal and press enter, then give it a few seconds to install.

3

Verify installation

In PowerShell, type this command and hit enter:

venus --help

If Venus CLI was installed successfully, you should see the list of available commands and options.

Manually installing the Venus CLI

You can always manually download and install the Venus CLI here.

Updating the Venus CLI

We'll be shipping improved versions of the Venus CLI frequently, so you'll want to keep it up to date. When you use the CLI, it will alert you when there is a new version available for installation.

To update the Venus CLI to the latest version, go to your Terminal and type:

venus update

Build a new game for Venus

Now that you have the Venus CLI installed, you're all set to build a new game for Venus.