Skip to content
DHD

Installation

Installation

Section titled “Installation”

DHD can be installed in several ways depending on your preferences and system setup.

Prerequisites

Section titled “Prerequisites”
  • Rust (for building from source)
  • Git (for cloning the repository)
  • Bun (optional, for TypeScript type checking in your modules) - install from https://bun.sh

Installation Methods

Section titled “Installation Methods”
Section titled “From Source (Recommended)”

The most up-to-date way to install DHD is by building from source:

Terminal window
# Clone the repository
git clone https://github.com/korora-tech/dhd
cd dhd


# Build and install
cargo install --path .

This will install the dhd binary to your Cargo bin directory (usually ~/.cargo/bin/).

Using Cargo

Section titled “Using Cargo”

Once DHD is published to crates.io:

Terminal window
cargo install dhd

Pre-built Binaries

Section titled “Pre-built Binaries”

Pre-built binaries for common platforms will be available from the GitHub Releases page.

Linux/macOS

Section titled “Linux/macOS”
Terminal window
# Download the latest release (example for Linux x64)
curl -LO https://github.com/korora-tech/dhd/releases/latest/download/dhd-linux-x64.tar.gz


# Extract
tar -xzf dhd-linux-x64.tar.gz


# Move to PATH
sudo mv dhd /usr/local/bin/


# Make executable
sudo chmod +x /usr/local/bin/dhd

Windows

Section titled “Windows”

Download the appropriate .exe file from the releases page and add it to your PATH.

Package Managers

Section titled “Package Managers”

Support for popular package managers is planned:

Homebrew (macOS/Linux)

Section titled “Homebrew (macOS/Linux)”
Terminal window
# Coming soon
brew install korora-tech/tap/dhd

AUR (Arch Linux)

Section titled “AUR (Arch Linux)”
Terminal window
# Coming soon
yay -S dhd

Verify Installation

Section titled “Verify Installation”

After installation, verify DHD is working:

Terminal window
# Check version
dhd --version


# Show help
dhd --help

Shell Completion

Section titled “Shell Completion”

DHD can generate shell completions for better command-line experience:

Bash

Section titled “Bash”
Terminal window
dhd completion bash > ~/.local/share/bash-completion/completions/dhd

Zsh

Section titled “Zsh”
Terminal window
dhd completion zsh > ~/.zfunc/_dhd

Fish

Section titled “Fish”
Terminal window
dhd completion fish > ~/.config/fish/completions/dhd.fish

PowerShell

Section titled “PowerShell”
Terminal window
dhd completion powershell | Out-String | Invoke-Expression

TypeScript Support (Optional)

Section titled “TypeScript Support (Optional)”

For the best development experience when writing DHD modules, install the TypeScript definitions:

Terminal window
# In your DHD modules directory
bun init -y
bun add --dev @korora-tech/dhd-types


# Generate type definitions
dhd codegen

This enables:

  • Autocompletion in your editor
  • Type checking for your modules
  • IntelliSense documentation

Updating DHD

Section titled “Updating DHD”

To update DHD to the latest version:

From Source

Section titled “From Source”
Terminal window
cd /path/to/dhd
git pull
cargo install --path . --force

Using Cargo

Section titled “Using Cargo”
Terminal window
cargo install dhd --force

Uninstalling

Section titled “Uninstalling”

To remove DHD from your system:

Cargo Installation

Section titled “Cargo Installation”
Terminal window
cargo uninstall dhd

Manual Installation

Section titled “Manual Installation”
Terminal window
sudo rm /usr/local/bin/dhd

Troubleshooting

Section titled “Troubleshooting”

Command Not Found

Section titled “Command Not Found”

If dhd is not found after installation, ensure the installation directory is in your PATH:

Terminal window
# For Cargo installations
export PATH="$HOME/.cargo/bin:$PATH"


# Add to your shell config file (.bashrc, .zshrc, etc.)
echo 'export PATH="$HOME/.cargo/bin:$PATH"' >> ~/.bashrc

Permission Errors

Section titled “Permission Errors”

If you encounter permission errors during installation:

  1. Avoid using sudo with cargo
  2. Ensure you have write permissions to the installation directory
  3. Consider using --root flag to install to a different location

Build Errors

Section titled “Build Errors”

If building from source fails:

  1. Ensure you have the latest stable Rust toolchain:

    Terminal window
    rustup update stable

  2. Check for missing system dependencies:

    Terminal window
    # Ubuntu/Debian
    sudo apt-get install build-essential pkg-config libssl-dev
    

    # Fedora
    sudo dnf install gcc pkg-config openssl-devel
    

    # macOS
    xcode-select --install

Next Steps

Section titled “Next Steps”

Now that you have DHD installed: