Skip to content
rootformDocs

Guide

Install Rootform

Markdown
On this pageOverview

Choose your platform, install Rootform, then verify the executable. Embedded Dialects are included and need no additional Rootform configuration for your first architecture.

Check provider coverage for interpreted types, provider bindings and input limits before choosing a runtime.

Recommended

curl -fsSL https://rootform.dev/install | sh
Shell

Verify

rootform version
Shell

Other options

Homebrew:

brew install rootform-dev/tap/rootform
Shell

Manual installation

Use a release archive when you need exact binary bytes, checksum evidence, or a transfer to a machine without network access. From Rootform v0.1.0, take the archive for your platform and SHA256SUMS:

PlatformArchive
macOS, Apple siliconrootform_0.1.0_darwin_arm64.tar.gz
macOS, Intelrootform_0.1.0_darwin_amd64.tar.gz
Linux, x86-64rootform_0.1.0_linux_amd64.tar.gz
Linux, ARM64rootform_0.1.0_linux_arm64.tar.gz
Windows, x86-64rootform_0.1.0_windows_amd64.zip

Release archives include binary license and third-party notices. Match the archive against its SHA256SUMS entry before extraction:

macOS Shell
shasum -a 256 rootform_0.1.0_darwin_arm64.tar.gz
Linux Shell
sha256sum rootform_0.1.0_linux_amd64.tar.gz
Windows PowerShell
Get-FileHash .\rootform_0.1.0_windows_amd64.zip -Algorithm SHA256

Extract the .tar.gz or .zip, then place rootform or rootform.exe in a directory on PATH. Run rootform version to confirm the executable.

To run a container, pin the image by index digest instead of using an archive. See Container usage. For a disconnected project, prepare exact third-party Dialects and Policy Packs as described in Locks and vendored content.

Update or remove Rootform

Update package-managed installations with their package managers:

  • Homebrew: brew upgrade rootform-dev/tap/rootform
  • WinGet: winget upgrade --id Rootform.Rootform --exact
  • Shell installer: run the recommended install command again. It replaces the executable in the same installation directory.
  • Manual archive: replace the executable with the binary from the new release, then verify it with rootform version.
  • Container: pull the selected release tag again, for example docker pull ghcr.io/rootform-dev/rootform:0.1.0.

Remove package-managed installations with:

  • Homebrew: brew uninstall rootform-dev/tap/rootform
  • WinGet: winget uninstall --id Rootform.Rootform --exact
  • Shell installer: remove ~/.local/bin/rootform by default, or the file under the custom ROOTFORM_INSTALL_DIR.
  • Manual archive: remove rootform or rootform.exe from its PATH directory.
  • Container: docker image rm ghcr.io/rootform-dev/rootform:0.1.0.

These steps remove the executable or image. rootform uninstall removes installed Dialects or Policy Packs from $ROOTFORM_HOME; it does not remove the executable. See the uninstall command reference.

Continue with the quickstart to analyze a sample plan, or analyze your own plan or state right away.