NokVault
Install NokVault
Browse documentation

Version 0.4.1

Search documentation

Search documentation

    Installation

    Install NokVault with a package manager, an attested release binary, or a local Go build. Prefer verified releases for production use.

    Homebrew

    On macOS, install the hash-pinned formula from the NokVault tap:

    homebrew bash 
    brew tap jimididit/nokvault https://github.com/jimididit/nokvault.git
brew install jimididit/nokvault/nokvault

    Scoop

    On Windows, install the hash-pinned Scoop manifest directly from the repository:

    scoop bash 
    scoop install https://raw.githubusercontent.com/jimididit/nokvault/main/scoop/nokvault.json

    Release binaries

    Download a pre-built binary for Windows, Linux, or macOS from GitHub Releases.

    1. Choose the artifact for your platform and architecture.
    2. On Linux and macOS, make it executable: chmod +x nokvault.
    3. Move it into a directory on your PATH, or run it from the download location.

    Verify release provenance

    Releases published after provenance support was enabled include SHA-256 checksums and a GitHub build attestation. Compare the downloaded binary with checksums.txt, then verify that GitHub Actions built it from this repository:

    attestation bash 
    gh attestation verify ./nokvault-linux-amd64 --repo jimididit/nokvault

    Replace the filename with the artifact for your platform. The command requires the GitHub CLI and an internet connection.

    An APT repository is not currently published. Linux users should download the attested binary for their architecture from GitHub Releases.

    Build from source

    Build NokVault from source when you need the latest tip or a customized build.

    Prerequisites

    • Go 1.25.11 or later
    • Git

    Build steps

    build bash 
    git clone https://github.com/jimididit/nokvault.git
cd nokvault

# Windows
go build -o nokvault.exe ./cmd/nokvault

# Linux/macOS
go build -o nokvault ./cmd/nokvault

    The binary is created in the current directory. Move it onto your PATH for system-wide use.

    Cross-compilation

    Build binaries for other platforms from your current machine:

    cross-compile bash 
    # Windows (64-bit)
GOOS=windows GOARCH=amd64 go build -o nokvault-windows-amd64.exe ./cmd/nokvault

# Linux (64-bit)
GOOS=linux GOARCH=amd64 go build -o nokvault-linux-amd64 ./cmd/nokvault

# macOS (Intel)
GOOS=darwin GOARCH=amd64 go build -o nokvault-darwin-amd64 ./cmd/nokvault

# macOS (Apple Silicon)
GOOS=darwin GOARCH=arm64 go build -o nokvault-darwin-arm64 ./cmd/nokvault

    Verify installation

    Confirm the binary runs:

    bash bash 
    nokvault --version

    You should see the version number. If the shell reports “command not found,” ensure the binary is on your PATH.