Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.gateways.app/llms.txt

Use this file to discover all available pages before exploring further.

​
macOS and Linux

The installer expects bash: 
curl -fsSL https://gws.run/install.sh | bash
This installs a prebuilt binary under ~/.local/bin and updates ~/.zshrc / ~/.bashrc when present. Open a new terminal, then run gateways or gws-cli.

​
Windows

PowerShell (x64 or ARM64): 
iwr https://gws.run/install.ps1 -useb | iex
Binaries go to %USERPROFILE%\.local\bin. Open a new window or refresh PATH.

​
From a repository checkout

From the cli directory (where go.mod lives), run ./install.sh. Options include --no-modify-shell and --no-reexec. Set GATEWAYS_INSTALL_DIR to change the install path, or GATEWAYS_SOURCE_DIR to build from source.

​
Build from source

Requires Go 1.21+: 
cd cli
CGO_ENABLED=0 go build -o gateways ./cmd/gateways
./gateways version

​
Next