Skip to content
Installation

Installation

apigent ships as a single static binary with no runtime dependencies. Pick one install method, then verify and continue to the Quickstart.

Install

macOS and Linux:

brew tap bsreeram08/apigent https://github.com/bsreeram08/apigent
brew install apigent

Verify installation

apigent --version
apigent docs run      # prints the flags of `apigent run`

Shell completion

# Bash (~/.bashrc)
source <(apigent completion bash)

# Zsh (~/.zshrc)
source <(apigent completion zsh)

# Fish (~/.config/fish/config.fish)
apigent completion fish | source

Where apigent keeps data

PathContents
~/.local/share/apigent/apigent.dbSaved requests, environments, collections and execution records (LevelDB)
~/.local/share/apigent/.secret-keyMachine key for encrypted secrets (mode 0600)
.apigent/ in a projectProject-backed collections and environments, created by apigent init

Configuration is loaded from the first file found:

  1. Path set in $APIGENT_CONFIG_PATH
  2. .apigentrc (current directory)
  3. ~/.apigentrc
  4. ~/.config/apigent/config.toml
[general]
history_depth = 100
auto_template = true
timeout = "30s"

[output]
default_format = "auto"
syntax_highlight = true
json_pretty = true

Update

Installed withUpdate with
Homebrewbrew upgrade apigent
Install script or pre-built binaryapigent update
Container imagedocker pull ghcr.io/bsreeram08/apigent:latest (or bump your pinned tag)
Sourcegit pull && go build -o apigent ./cmd/apigent

apigent update checks the latest release metadata and replaces the binary with the matching macOS or Linux asset for your CPU architecture. See apigent update.

Next steps

Continue to the Quickstart. AI agents should run apigent docs first; see Agent mode.