Skip to main content

​
Telnyx Development: Telnyx CLI — Documentation Index

Telnyx CLI documentation within the Development section of the Telnyx developer docs (https://developers.telnyx.com). Root index: https://developers.telnyx.com/llms.txt · Development index: https://developers.telnyx.com/development/llms-txt.md · Full content for this subsection: https://developers.telnyx.com/development/llms/development-telnyx-cli-llms-full-txt.md
  • Overview: The Telnyx CLI is the official command-line interface for managing phone numbers, messaging, calls, and other Telnyx resources from your terminal.
  • Scripting & Automation: Automate workflows with the Telnyx CLI using output formats, filtering, and JSON parsing — patterns for shell scripts, cron jobs, and CI/CD pipelines.
  • Command Reference: Comprehensive reference for every Telnyx CLI command, auto-generated from the Telnyx REST API with options, examples, and per-resource usage notes.
  • Troubleshooting: Troubleshoot common Telnyx CLI errors including authentication failures, missing API keys, and request errors, with solutions mapped to API error codes.

​
Getting Started

  • Install: Install the Telnyx CLI on macOS, Windows, or Linux using Homebrew, the install script, or by downloading a prebuilt binary for your platform.
  • Quickstart: Install the Telnyx CLI, configure authentication, and run your first command in five minutes — send a message, list numbers, or place a call.
  • Authentication: Authenticate the Telnyx CLI by setting the TELNYX_API_KEY environment variable so commands can call Telnyx APIs on your account’s behalf.

​
Workflows

  • 10DLC Registration: Register your business for US A2P 10DLC messaging using the Telnyx CLI, from brand creation through campaign approval, with copy-paste shell commands.

​
Legacy CLI (Deprecated)

  • Overview: Documentation for the deprecated @telnyx/api-cli Node.js package. For new projects use the current Telnyx CLI with simpler authentication.
  • Installation: Install the deprecated @telnyx/api-cli Node.js CLI for legacy projects. New projects should use the current Telnyx CLI for better support.
  • Authentication: Configure API keys and switch between multiple authentication profiles in the deprecated @telnyx/api-cli legacy Node.js CLI.
  • Command Reference: Complete command reference for the deprecated @telnyx/api-cli Node.js CLI, retained for legacy projects. New projects should use the current Telnyx CLI.