Install Legacy CLI

This CLI is deprecated. For new projects, use the current Telnyx CLI instead.

Requirements

The legacy CLI requires Node.js 20 or later.

Install globally via npm:

npm install -g @telnyx/api-cli

This makes the telnyx command available from any directory.

telnyx --version

Expected output:

@telnyx/api-cli/1.1.0 darwin-arm64 node-v20.10.0

To update to the latest version:

npm update -g @telnyx/api-cli

If the command isn’t found after installation:

Check npm’s global bin is in your PATH:

npm config get prefix
# Add <prefix>/bin to your PATH if needed

Restart your terminal or reload your shell config:
source ~/.bashrc # or ~/.zshrc

If you get EACCES permission errors:

Configure API keys and profiles

⌘I