Installation

Stardust can be installed on macOS, Linux, and Windows. Choose your preferred installation method below.

macOS

The recommended way to install Stardust on macOS:

bash

brew tap nexlabstudio/tap
brew install stardust

To upgrade to the latest version:

bash

brew upgrade stardust

Install using our installer script:

bash

curl -sSL https://raw.githubusercontent.com/nexlabstudio/stardust/dev/install.sh | bash

This installs to /usr/local/bin by default. To customize:

bash

STARDUST_INSTALL_DIR=~/.local/bin curl -sSL https://raw.githubusercontent.com/nexlabstudio/stardust/dev/install.sh | bash

The recommended way to install Stardust on Linux:

bash

curl -sSL https://raw.githubusercontent.com/nexlabstudio/stardust/dev/install.sh | bash

The script automatically detects your architecture (x64 or ARM64).

Install from the Snap Store:

bash

snap install stardust

The recommended way to install Stardust on Windows:

powershell

scoop install https://raw.githubusercontent.com/nexlabstudio/stardust/dev/scoop/stardust.json

Install using Chocolatey:

powershell

choco install stardust

If you already have the Dart SDK installed, you can install Stardust as a global package:

bash

dart pub global activate stardust

📝 Note

Make sure ~/.pub-cache/bin is in your PATH.

Download pre-built binaries from the GitHub Releases page.

Download the appropriate archive for your platform from the releases page.

bash

# macOS/Linux
tar -xzf stardust-*.tar.gz

# Windows (PowerShell)
Expand-Archive stardust-*.zip

Move the stardust binary to a directory in your PATH:

bash

# macOS/Linux
sudo mv stardust /usr/local/bin/

# Windows - move to a directory in your PATH

After installation, verify that Stardust is working:

bash

stardust --version

You should see output like:

Stardust v0.1.0

Now that Stardust is installed, create your first documentation site.