When to Use the CLI vs the API
| Use Case | CLI | API |
|---|---|---|
| Quick manual tasks | ✅ Best choice | Overkill |
| Scripting & automation | ✅ Great for bash/shell | ✅ Better for complex logic |
| CI/CD pipelines | ✅ Simple integrations | ✅ Full control |
| Production applications | ❌ Not recommended | ✅ Use SDKs or direct API |
| Exploring the API | ✅ Fast iteration | Slower feedback loop |
Features
Full API Coverage
Access all Telnyx APIs — messaging, voice, numbers, 10DLC, AI, verification, storage, and more
Multiple Output Formats
JSON, YAML, pretty-print, and raw output for scripting and human readability
Auto-generated from OpenAPI
Always in sync with the latest Telnyx API endpoints
Debug Mode
Inspect HTTP requests and responses for troubleshooting
Quick Example
Installation
Install via Go:Requires Go 1.22+. After installation, ensure
$GOPATH/bin is in your PATH.Installation Guide
Detailed installation instructions and troubleshooting
Documentation
Quickstart
Get up and running in 5 minutes
Authentication
Configure your API key
General Usage
Output formats, filtering, and scripting
Command Reference
Full list of all CLI commands
Resources
GitHub Repository
View source, report issues, and contribute
Releases & Changelog
Release notes and version history
API Reference
Full API documentation (CLI wraps these endpoints)