Installation - withsecrets

Get withsecrets up and running on your system with these simple installation methods.

Choose your installation method:

Arch Linux (PKGBUILD)

withsecrets ships a PKGBUILD you can use to build and install a withsecrets-bin package from GitHub release binaries.

# One-time setup (build tools)
sudo pacman -S --needed base-devel git

# Build from the PKGBUILD in the repo
git clone https://github.com/mistweaverco/withsecrets.git
cd withsecrets/scripts

# Build & install the package
makepkg -si

The package name is withsecrets-bin and installs the binary as ws (with a kuba compatibility symlink). If you maintain a custom repo / AUR workflow, you can adapt the PKGBUILD.

Manual Installation

Download the latest release from the download page.

Or visit our GitHub releases page.

Operating Systems

Linux: x86_64, ARM64, ARMv7
macOS: Intel, Apple Silicon (M1/M2)
Windows: x86_64

Dependencies

withsecrets is a single binary with no external dependencies required.

Network Access

Required for downloading releases and accessing cloud provider APIs.

After installation, verify that withsecrets is working correctly:

ws --version

You should see the current version of withsecrets displayed.

Configure withsecrets

Set up your configuration file to start using withsecrets with your cloud providers.

Configuration Guide

Learn Usage

Discover how to use withsecrets to run your applications with secure environment variables.

Usage Guide

Need help? Check out our GitHub issues or join our Discord community.

Installation Guide

Automatic Installation

curl & zsh (Linux/macOS)

curl & bash (Linux/macOS)

wget & zsh (Linux/macOS)

wget & bash (Linux/macOS)

Arch Linux (AUR)

Arch Linux (PKGBUILD)

PowerShell (Windows)

Manual Installation

System Requirements

Operating Systems

Dependencies

Network Access

Verification

Next Steps

Configure withsecrets

Learn Usage