team-telnyx/ai

telnyx-cli

- Use the Telnyx CLI to manage phone numbers, send messages, make calls, and access all Telnyx APIs from the terminal.

ソースを見る

使い方

  1. インストールコマンドをコピーし、自分の環境へ導入する前にソースを確認します。
  2. 必要なツール、認証情報、対応環境を原文で確認します。
  3. 入力と成果物を指定し、出力を資料と照合します。
npx skills add https://github.com/team-telnyx/ai --skill telnyx-cli

開始前の確認

  • 導入にはモデル契約、API枠、ファイルへのアクセス許可は含まれません。
  • スター数や導入数は活動の指標であり、独立した品質・安全性試験ではありません。
リポジトリの原文

見出し、例、コード、表、リンク、参照画像を含む原文を表示しています。

Telnyx CLI

The Telnyx CLI provides command-line access to the entire Telnyx API. Every API endpoint maps to a CLI command — 946 commands covering messaging, voice, numbers, IoT, AI, and more.

Installation

bash
# Homebrew (macOS/Linux)
brew install telnyx/tap/telnyx

# Go install
go install github.com/team-telnyx/telnyx-go/cmd/telnyx@latest

# Or download a binary from GitHub releases:
# https://github.com/team-telnyx/telnyx-go/releases

Authentication

bash
export TELNYX_API_KEY="KEY..."

The CLI reads TELNYX_API_KEY from your environment. Set it once in your shell profile.

Command Discovery

The CLI is fully self-documenting. Use --help at any level to explore:

bash
# Top-level resource list
telnyx --help

# Commands for a specific resource
telnyx messages --help

# Full usage for a specific command
telnyx messages create --help

Command Structure

Commands follow a consistent pattern:

text
telnyx <resource> <action> [--flag value ...]

Resources match API paths. Actions are list, create, get, update, delete, and resource-specific verbs.

Common Operations

Send an SMS

bash
telnyx messages create \
  --from +15551234567 \
  --to +15559876543 \
  --text "Hello from the CLI"

List phone numbers

bash
telnyx phone-numbers list --page-size 25

Search for available numbers

bash
telnyx available-phone-numbers list \
  --country-code US \
  --state CA \
  --features sms

Order a phone number

bash
telnyx number-orders create \
  --phone-numbers +15551234567

Make an outbound call

bash
telnyx calls create \
  --connection-id 1234567890 \
  --from +15551234567 \
  --to +15559876543

List SIM cards

bash
telnyx sim-cards list --page-size 10

Create an AI assistant

bash
telnyx assistants create \
  --name "Support Agent" \
  --model telnyx_ai

Check account balance

bash
telnyx balance get

Output Formats

bash
# Default: human-readable table
telnyx phone-numbers list

# JSON output for scripting
telnyx phone-numbers list --format json

# Pipe to jq for filtering
telnyx phone-numbers list --format json | jq '.data[].phone_number'

When to Use CLI vs SDK

Use caseRecommended
Quick one-off operationsCLI
Shell scripts and automationCLI
Application codeSDK (Python, JS, Go, Java, Ruby)
Interactive explorationCLI
CI/CD pipelinesCLI or SDK
Complex business logicSDK

タスクに関連する項目

同じリポジトリから

関連する Skills

すべての Skills