Geode CLI

Install and configure the Geode command-line interface

Geode has its own CLI tool to aid in many tasks involved in making mods, such as packing assets, generating fonts, managing installed SDK versions, etc. While it is technically possible to use Geode without the CLI, there is little reason not to install it as it’s required for nearly everything in practice.

Installation

Windows

Using Scoop (Recommended)

You can use Scoop to easily install the CLI:

scoop bucket add extras
scoop install geode-sdk-cli

Later on, you can easily update the Geode CLI:

scoop update geode-sdk-cli

Using winget

If you prefer, you can also use WinGet:

winget install GeodeSDK.GeodeCLI

To update the CLI, run:

winget upgrade GeodeSDK.GeodeCLI

Manual Installation (Not Recommended)

1. Download the CLI

   Download the latest Windows release from GitHub

2. Extract the executable

   Extract geode.exe into some folder on your computer

3. Copy the path

   Select the executable in File Explorer, Shift + Right-Click it and select Copy as Path

4. Open environment variables

   Search Edit the system environment variables on Windows search. Alternatively, you can open up Control Panel and search for it, then select Edit the system environment variables or to skip straight to step 5 select Edit environment variables for your account.

5. Edit environment variables

   Click Environment Variables...

6. Edit the Path variable

   In the top User variables section, select the Path variable and click Edit

7. Add the CLI path

   Click New and paste the path of the CLI executable you copied at Step 2. Remove the \geode.exe from the end; the path has to point to the directory with Geode CLI, not the CLI itself.

8. Save changes

   Click OK to close the environment variable windows.

Verify Installation

After installing the CLI, you should now be able to run the following command in your terminal:

geode --version

If this doesn’t work, try restarting your terminal and/or computer.

It is recommended that you set up a profile afterwards.

macOS

You can easily install the CLI via Brew:

brew install geode-sdk/geode/geode-cli

It is recommended that you set up a profile afterwards.

Linux

We provide prebuilt Linux binaries in the CLI releases page. Since Linux distros differ between each other, you need to figure out yourself how to add this binary to your global path so CMake can find it. As long as geode --version works anywhere, everything should be fine.

Once you figure that out, it is recommended that you set up a profile afterwards.

Profile Setup

A profile is just an instance of Geometry Dash. The CLI allows keeping multiple separate installations of Geometry Dash at once, though most users will just have a single installation of GD with Geode on it. If you do have GDPSes with Geode on them installed, you can run geode profile add to add them to the list of known profiles. You need to have at least one profile set up so your mods can be automatically installed post build.

To setup a new profile, simply run the geode config setup command on your terminal.