GDSuite Docs

Install

Get GDSuite on your computer, then add it to a Godot project.

Installing GDSuite takes two steps: put the gdsuite program on your computer once, then add GDSuite to each Godot project you want it to watch.

You only install GDSuite: the formatter, linter, type checker, test runner and code health tool are built into the gdsuite program, so there is nothing else to download (see Under the hood if you are curious).

Coming soon: the Godot Asset Store

GDSuite will be installable from the Godot Asset Store, inside the editor, with no terminal needed. Until then, use one of the two ways below.

1. Get the gdsuite program

You need Godot 4.5 or newer.

Download the archive for your computer from the latest GitHub release:

Your computerFile to download
Windowsgdsuite-v<version>-x86_64-pc-windows-msvc.zip
macOS, Apple Silicon (M1 and later)gdsuite-v<version>-aarch64-apple-darwin.tar.gz
macOS, Intelgdsuite-v<version>-x86_64-apple-darwin.tar.gz
Linuxgdsuite-v<version>-x86_64-unknown-linux-musl.tar.gz

Unpack it and put the gdsuite program (gdsuite.exe on Windows) in a folder on your PATH, so a terminal finds it from anywhere:

  • Windows: create a folder such as C:\Tools, put gdsuite.exe in it, then search the Start menu for "Edit environment variables for your account", select Path, click Edit, then New, and add C:\Tools.
  • macOS and Linux: move it to ~/.local/bin (create the folder if needed) and make sure that folder is on your PATH.

With Rust 1.96 or newer:

cargo install gdsuite

Open a new terminal and check it works:

gdsuite --version

2. Use it in your project

There is nothing to set up. In a terminal, go to your project's folder (the one with project.godot) and run a check:

cd path/to/my-game
gdsuite check

GDSuite works with its defaults until you change them. The first gdsuite test adds the files your tests need to run inside Godot, and says so.

As you go, your project gets:

WhatWhenCommit it?
addons/gdtest/The first gdsuite test: lets your tests run inside GodotYes
addons/gdsuite/The first gdsuite test: GDSuite in the Godot editorYes
gdsuite.tomlWhen you want to change a setting (Configure)Yes
.gdsuite/The first gdsuite test: what GDSuite keeps for this project on this computerNo (added to .gitignore)

Prefer to set everything up first?

gdsuite init writes a gdsuite.toml with every setting at its default and installs the test addons, so the whole team sees them in the first commit.

If Godot isn't found

GDSuite looks for Godot in the usual places. If yours has another name or lives somewhere else, tell GDSuite once where it is:

gdsuite init --godot-exe "C:/Tools/Godot_v4.7-stable_win64.exe"

GDSuite remembers it for this project, on this computer (the path is not written in gdsuite.toml, so teammates keep their own). You can also set the GODOT_EXE environment variable once for all your projects, or pass --godot-exe to any command.

3. If something doesn't work

gdsuite doctor

Run it in your project's folder. It lists Godot and each tool built into GDSuite, with its version, and ends with:

[gdsuite:doctor] status ok

If it ends with status error, each line above says what is missing and how to fix it. See Troubleshooting.

Updating GDSuite

The tools are part of the gdsuite program, so updating GDSuite updates everything. Get the new gdsuite the way you got the first one: download it again, or run cargo install gdsuite again.

Projects set up by GDSuite 0.4 or earlier downloaded their tools into .gdsuite/, and may have their versions written in gdsuite.toml. Run this once in each of them:

gdsuite update

It removes the old versions from gdsuite.toml and the downloaded tools from .gdsuite/. Until you run it, commands warn that the project still uses the downloaded tools.

Next

Your first 10 minutes walks you through a first check, a fix and a test.