Installation

Get up and running with the Blocktools suite with a single command. No admin rights required.

One-Line Installers

We provide convenient installation scripts for all major operating systems. The scripts install the binaries to a user-owned directory, so they do not require sudo or administrator privileges.

macOS & Linux (via Shell)

Open your terminal and run the following command to install all tools:

curl -sSL https://download.blocktools.dev/install.sh | sh -s -- all

To install a specific tool, replace all with the tool's name (e.g., sol-console).

Windows (via PowerShell)

Open a new PowerShell terminal and run the following command to install all tools:

iex (irm https://download.blocktools.dev/install.ps1) -ToolToInstall all

To install a specific tool, replace all with the tool's name (e.g., receipt-parse).

System Requirements

  • Operating System: macOS (Intel & Apple Silicon), Linux, or Windows.
  • Dependencies: None. Our tools are self-contained static binaries.

What the Script Does

For transparency, our installation script performs the following actions:

  1. Detects your operating system (e.g., `darwin`, `linux`, `windows`) and architecture (e.g., `x86_64`, `arm64`).
  2. Downloads the latest compressed binary for your system from our secure server.
  3. Extracts the binary from the archive.
  4. Moves the executable to a user-local directory (~/.local/bin on macOS/Linux, %LOCALAPPDATA%\Programs\Blocktools on Windows).
  5. Checks if the installation directory is in your PATH and provides instructions if it's not.

Verifying the Installation

After the script finishes, you can verify that a tool was installed correctly by running its --version command:

$ sol-console --version
sol-console 1.2.0

Troubleshooting

If you get a "command not found" error after installation, the installation directory is likely not in your system's PATH. The script will provide you with the exact command to run to add it to your shell's configuration file (e.g., .zshrc, .bash_profile, or your PowerShell profile).