Skip to main content
The Telnyx CLI is supported on macOS, Windows, and Linux.
The Telnyx CLI requires Node.js 20 or later. If you’re using an older version, please upgrade before installing.

​
Installation

Install the CLI globally via npm: 
npm install -g @telnyx/api-cli
This makes the telnyx command available from any directory.

​
Verify Installation

telnyx --version
You should see output similar to: 
@telnyx/api-cli/1.1.0 darwin-arm64 node-v20.10.0

​
Update

To update to the latest version: 
npm update -g @telnyx/api-cli

​
Troubleshooting

​
”command not found: telnyx”

If the command isn’t found after installation:
  1. Verify it installed: 
    npm list -g @telnyx/api-cli
  2. Check npm’s global bin is in your PATH: 
    npm config get prefix
# Add <prefix>/bin to your PATH if needed
  3. Restart your terminal or reload your shell config: 
    source ~/.bashrc  # or ~/.zshrc

​
Permission errors

If you get EACCES permission errors:
  1. Follow npm’s guide to fix permissions
  2. Or use a Node version manager (nvm, fnm) which doesn’t require sudo

​
Next Steps

Quickstart

Configure authentication and run your first commands

Command Reference

Full list of all CLI commands