Install

Run the one command for your system and check that topaz starts. The sections from npm onward are for other ways to install and for the published files.

Install with one command

On macOS and Linux, run this command in a terminal.

curl -fsSL https://topaz.ooo/install.sh | sh

On Windows, run this command in PowerShell.

irm https://topaz.ooo/install.ps1 | iex

Each script picks the latest published release for your system and downloads the compressed program. It checks the download and the decompressed program against the SHA-256 checksums published with that release. The script puts topaz in ~/.topaz/bin on macOS and Linux, and in %LOCALAPPDATA%\Topaz\bin on Windows.

Check the installation

Open a new terminal and check that it finds Topaz.

topaz version

The output is Topaz followed by the installed version. Read that version when checking an installation or reporting a problem.

The latest published release is v5.20.4.

If the command is not found, open a new terminal and check that the installation folder is on PATH. The Windows script adds its folder to your user PATH. On macOS and Linux, the script prints the export PATH=... line to add when the folder is not on PATH yet.

When topaz version works, return to First Program to write and run your first file.

Start without installing

The Playground edits, checks, and runs Topaz in your browser without the CLI. It loads the compiler and interpreter WASM in a Worker. To call Topaz functions from your own JavaScript application, see Call Topaz from JavaScript.

Install with npm

With Node.js 18 or newer, npm can install Topaz. The topaz-lang package runs an installer script that downloads the program for your system and checks it against the published SHA-256 checksums.

Install for every folder

npm install -g --allow-scripts=topaz-lang topaz-lang
topaz version

--allow-scripts=topaz-lang lets npm run the installer of topaz-lang and of no other package. To install one of the published releases below instead of the latest, put its number after topaz-lang@.

Install in one folder

To keep Topaz inside one project folder, install it there and run it through npx.

npm install topaz-lang
npx topaz version

The same command is at node_modules/.bin/topaz.

Answer the install script warning

npm 11 prints an npm warn allow-scripts warning that names topaz-lang and its postinstall script. The installer has still run. To record your approval in the folder's package.json and stop the warning, run this command in that folder.

npm approve-scripts topaz-lang

npm 12 runs an install script only with your permission. If npx topaz version reports binary not found, the installer did not run. Approve it as above, then run the installer again.

npm rebuild topaz-lang

Download a file directly

Each published release lists its executables with their size and SHA-256 checksum. The .gz, .xz, and .br files hold the same program, compressed. The versions below are the published releases.

Published October 17, 2026 · Release manifest

• All checksums
• Signature
• Signature details
• Public key

Check a file before you run it. On Linux, print its SHA-256 checksum with sha256sum.

sha256sum topaz-linux-x86_64

On macOS, use shasum -a 256 topaz-macos-aarch64 with your file name. In PowerShell on Windows, use Get-FileHash.

Get-FileHash .\topaz-windows-x86_64.exe -Algorithm SHA256

The value must match the SHA-256 shown for that file and the value in its .sha256 file. PowerShell prints it in capital letters. A compressed file needs one more step. Decompress a .gz file with gzip -d and an .xz file with xz -d. Decompress a .br file with brotli -d from the Brotli tools, or download the uncompressed executable in the table if you do not have them. Then check the program you get against the executable's SHA-256.

Put the program in a folder on PATH under the name topaz, or topaz.exe on Windows. On macOS and Linux, also make it executable.

mkdir -p ~/.topaz/bin
mv topaz-linux-x86_64 ~/.topaz/bin/topaz
chmod +x ~/.topaz/bin/topaz

Then check it with topaz version as above.

Add tools for native and Web builds

topaz check and topaz run need nothing else. Native builds also need Rust with Cargo for the target platform. Web builds also need the Rust target wasm32-unknown-unknown. You will use these tools in First Application.

Set up your editor

In VS Code or an Open VSX-compatible editor, install the official Topaz extension from the Visual Studio Marketplace or Open VSX Registry. It recognizes .tpz files, adds the Topaz icon, and highlights syntax.

The extension starts the installed topaz lsp to show error messages in the editor. The compiler is installed separately. Make sure the editor can find it on PATH, or set topaz.executablePath to its location. You can also use topaz check in the terminal.

Check the release signature

checksums.txt lists the SHA-256 of every file in a release. checksums.txt.sig is its Ed25519 signature. Download both with the release public key topaz-release.pub from the links under the file table, then check the signature with OpenSSL 3 in that folder.

openssl pkeyutl -verify -pubin -inkey topaz-release.pub -rawin -in checksums.txt -sigfile checksums.txt.sig

OpenSSL prints Signature Verified Successfully. The release manifest lists every file the release published.

Source and licenses

5.20.4 preserves the full Rust reference source under Apache-2.0.

Browse source

Read Public Source and Licenses for component terms and the historical source snapshot.

Release history

Choose a published release to see its files and source.