Skip to main content
Version: 0.1.0

Installation

:::warning Alpha Software Invowk™ is currently in alpha stage. While we strive for stability, expect breaking changes between releases as we stabilize the invowkfile format, module structure, and feature set. We recommend pinning to a specific version for production use and following the GitHub releases for migration guides. :::

Welcome to Invowk! Let's get you set up and running commands in no time.

Requirements​

Before installing Invowk, make sure you have:

  • Go 1.26+ (only if building from source)
  • Linux, macOS, or Windows - Invowk works on all three!

For container runtime features, you'll also need:

  • Docker or Podman installed and running

Installation Methods​

If you have Go installed, building from source is straightforward:

git clone https://github.com/invowk/invowk
cd invowk
go build -o invowk .

Then move the binary to your PATH:

# Linux/macOS
sudo mv invowk /usr/local/bin/

# Or add to your local bin
mv invowk ~/.local/bin/

Using Make (with more options)​

The project includes a Makefile with several build options:

# Standard build (stripped binary, smaller size)
make build

# Development build (with debug symbols)
make build-dev

# Compressed build (requires UPX)
make build-upx

# Install to $GOPATH/bin
make install

Verify Installation​

Once installed, verify everything works:

invowk --version

You should see the version information. If you get a "command not found" error, make sure the binary is in your PATH.

Shell Completion​

Invowk supports tab completion for bash, zsh, fish, and PowerShell. This makes typing commands much faster!

Bash​

# Add to ~/.bashrc
eval "$(invowk completion bash)"

# Or install system-wide
invowk completion bash > /etc/bash_completion.d/invowk

Zsh​

# Add to ~/.zshrc
eval "$(invowk completion zsh)"

# Or install to fpath
invowk completion zsh > "${fpath[1]}/_invowk"

Fish​

invowk completion fish > ~/.config/fish/completions/invowk.fish

PowerShell​

invowk completion powershell | Out-String | Invoke-Expression

# Or add to $PROFILE for persistence
invowk completion powershell >> $PROFILE

What's Next?​

Now that you have Invowk installed, head over to the Quickstart guide to run your first command!