> ## Documentation Index
> Fetch the complete documentation index at: https://developers.telnyx.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Telnyx CLI

> Command-line interface for Telnyx APIs

The Telnyx CLI is the official command-line interface for managing Telnyx resources directly from your terminal. Send messages, manage phone numbers, control calls, and more — all without leaving the command line.

## 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       |

The CLI is ideal for operators, developers exploring the API, and simple automation. For production applications, use the [Telnyx SDKs](/development/sdks) or call the [REST API](/api-reference/overview) directly.

## Features

<CardGroup cols={2}>
  <Card title="Full API Coverage" icon="code">
    Access all Telnyx APIs — messaging, voice, numbers, 10DLC, AI, verification, storage, and more
  </Card>

  <Card title="Multiple Output Formats" icon="table">
    JSON, YAML, pretty-print, and raw output for scripting and human readability
  </Card>

  <Card title="Auto-generated from OpenAPI" icon="rotate">
    Always in sync with the latest Telnyx API endpoints
  </Card>

  <Card title="Debug Mode" icon="bug">
    Inspect HTTP requests and responses for troubleshooting
  </Card>
</CardGroup>

## Quick Example

```bash theme={null}
# Set your API key
export TELNYX_API_KEY=KEY_xxxxxxxxxxxxx

# List your phone numbers
telnyx phone-numbers list

# Search for available phone numbers
telnyx available-phone-numbers list --filter.country-code US

# Send an SMS
telnyx messages send --from +15551234567 --to +15559876543 --text "Hello from CLI!"

# Check your balance
telnyx balance retrieve
```

## Installation

Install via Go:

```bash theme={null}
go install github.com/team-telnyx/telnyx-cli/cmd/telnyx@latest
```

<Note>
  Requires [Go 1.22+](https://go.dev/doc/install). After installation, ensure `$GOPATH/bin` is in your PATH.
</Note>

<Card title="Installation Guide" icon="download" href="/development/cli/getting-started/install">
  Detailed installation instructions and troubleshooting
</Card>

## Documentation

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/development/cli/getting-started/quickstart">
    Get up and running in 5 minutes
  </Card>

  <Card title="Authentication" icon="key" href="/development/cli/getting-started/authentication">
    Configure your API key
  </Card>

  <Card title="General Usage" icon="book-open" href="/development/cli/general-usage">
    Output formats, filtering, and scripting
  </Card>

  <Card title="Command Reference" icon="terminal" href="/development/cli/reference">
    Full list of all CLI commands
  </Card>
</CardGroup>

## Resources

<CardGroup cols={2}>
  <Card title="GitHub Repository" icon="github" href="https://github.com/team-telnyx/telnyx-cli">
    View source, report issues, and contribute
  </Card>

  <Card title="Releases & Changelog" icon="clock-rotate-left" href="https://github.com/team-telnyx/telnyx-cli/releases">
    Release notes and version history
  </Card>

  <Card title="API Reference" icon="book" href="https://developers.telnyx.com/api/overview">
    Full API documentation (CLI wraps these endpoints)
  </Card>
</CardGroup>