Install the Telnyx CLI

Install the Telnyx CLI on macOS, Windows, or Linux

The Telnyx CLI is supported on macOS, Windows, and Linux.

The Telnyx CLI requires Go 1.22 or later. If you don’t have Go installed, follow the official installation guide.

Installation

Install the CLI using Go:

go install github.com/team-telnyx/telnyx-cli/cmd/telnyx@latest

This downloads, compiles, and installs the telnyx binary to your Go bin directory.

Add to PATH

After installation, ensure the Go bin directory is in your PATH:

# Check your Go bin path
go env GOPATH

# Add to your shell profile (~/.bashrc, ~/.zshrc, etc.)
export PATH="$PATH:$(go env GOPATH)/bin"

Reload your shell or restart your terminal for changes to take effect.

Verify Installation

telnyx --version

You should see output similar to:

telnyx version 0.1.0

Update

To update to the latest version, run the install command again:

go install github.com/team-telnyx/telnyx-cli/cmd/telnyx@latest

Alternative: Run Without Installing

You can run the CLI directly without installing:

go run github.com/team-telnyx/telnyx-cli/cmd/telnyx@latest --help

Troubleshooting

”command not found: telnyx”

If the command isn’t found after installation:

1. Verify Go’s bin directory:

   ls $(go env GOPATH)/bin/telnyx
   

2. Add Go bin to your PATH:

   export PATH="$PATH:$(go env GOPATH)/bin"
   

3. Reload your shell config:

   source ~/.bashrc  # or ~/.zshrc
   

“command not found: go”

Install Go first:

• macOS: brew install go
• Linux: Use your package manager or download from go.dev
• Windows: Download the installer from go.dev

Build errors

If you encounter build errors:

1. Ensure you have Go 1.22+:

   go version
   

2. Clear Go’s module cache and retry:

   go clean -modcache
   go install github.com/team-telnyx/telnyx-cli/cmd/telnyx@latest
   

Next Steps

Quickstart

Configure authentication and run your first commands

Command Reference

Full list of all CLI commands

---