Gardn
DocumentationGetting started

Install Gardn

Install Gardn from the current source checkout or Nix flake.

Install Gardn

This guide installs the current pre-public Gardn source.

Release availability: Verified gardn-* release downloads are not publicly available yet. Use one of the source-based paths below and check the download status page before relying on a release artifact.

Build from a source checkout

Install Rust and Cargo, then run these commands from the repository root:

git clone https://github.com/masakirocorp/gardn.git
cd gardn
cargo install --path apps/gardn

cargo install --path apps/gardn must run from the cloned repository root, where the workspace and apps/gardn package are present. It installs the gardn executable into Cargo's normal binary directory. The default branch is pre-public and may change; pin a reviewed commit before using this command in automation.

Install with Nix

The current repository flake exposes the gardn package:

nix profile install "github:masakirocorp/gardn#gardn"

This Nix package is declared for x86_64 and aarch64 Linux and macOS. The Nix path does not provide a Windows installation.

Check the installation

Verify the executable and version:

gardn --version

The output starts with gardn followed by the current source version.

Continue with the quick-start tutorial, or return to the download status page for release availability.

Last updated on

On this page