Guide de démarrage rapide de l'interface de ligne de commande (CLI)
Ce produit Twilio est actuellement disponible en version bêta. Certaines fonctionnalités ne sont pas encore implémentées et d'autres peuvent être modifiées avant que le produit ne soit déclaré comme étant généralement disponible. Les produits bêta ne sont pas couverts par un SLA Twilio. En savoir plus sur l'assistance pour les produits bêta.
twilio-cli
vous permet de gérer vos ressources Twilio depuis votre terminal ou votre invite de commande. Installons‐la et passons‐la rapidement en revue.
Installer twilio-cli
Installation à l'aide de Homebrew
Pour installer twilio-cli
sur MacOS à l'aide de Homebrew, exécutez :
brew tap twilio/brew && brew install twilio
Installation à l'aide de Scoop
Pour installer twilio-cli
sur Windows à l'aide de Scoop, exécutez PowerShell en tant qu'administrateur, puis :
- Ajoutez le compartiment
twilio-cli
:
scoop bucket add twilio-scoop https://github.com/twilio/scoop-twilio-cli
- Installez l'application :
scoop install twilio
Installation à l'aide d'apt
Pour installer twilio-cli
sur des distributions telles que Debian, Ubuntu, Linux Mint, etc. à l'aide de l'outil Advanced Package Tool (apt), exécutez :
wget -qO- https://twilio-cli-prod.s3.amazonaws.com/twilio_pub.asc \
| sudo apt-key add -
sudo touch /etc/apt/sources.list.d/twilio.list
echo 'deb https://twilio-cli-prod.s3.amazonaws.com/apt/ /' \
| sudo tee /etc/apt/sources.list.d/twilio.list
sudo apt update
sudo apt install -y twilio
Exécution de l'image Docker
Pour exécuter twilio-cli
en tant qu'image Docker avec un shell bash interactif, exécutez :
docker run -it --rm twilio/twilio-cli bash
Pour plus d'informations sur l'utilisation, consultez la documentation Docker dédiée à twilio-cli.
Avertissement
Il est fortement recommandé d'utiliser l'une des autres méthodes d'installation si possible. L'installation à l'aide de npm ne fait pas de mise à jour automatique et utilise la version de Node.js de votre système, qui peut être plus ancienne que la version sur laquelle Twilio développe twilio-cli
.
Installation à l'aide de npm
Pour installer intégralement twilio-cli
afin de pouvoir l'utiliser depuis n'importe quel répertoire, utilisez :
npm install -g twilio-cli
Pour plus d'informations sur les méthodes d'installation, reportez‐vous à la documentation sur l'installation et les mises à jour de twilio-cli.
Se connecter à votre compte Twilio
Pour que twilio-cli
accède à votre compte Twilio et exécute des commandes en votre nom, vous devez vous connecter et fournir vos informations d'identification Twilio. Pour ce faire, exécutez :
twilio login
Vous serez alors invité à saisir votre SID de compte (Account SID) et votre jeton d'autorisation (Auth Token), tous deux disponibles sur le tableau de bord de la console Twilio.
Ceci va créer pour vous une clé API, qui sera stockée de manière sécurisée et utilisée pour émettre des requêtes authentifiées lorsque vous utilisez twilio-cli
. Cette clé API sécurisée ainsi que vos paramètres seront stockés localement sous forme de profil.
Reportez-vous au guide d'utilisation générale pour savoir comment utiliser plusieurs comptes ou profils avec twilio-cli
sur la même machine.
Installer la saisie semi‐automatique de la CLI (bash ou zsh uniquement)
Avec la saisie semi‐automatique, lorsque vous entrez une partie d'un paramètre, d'une commande ou d'une option, la CLI termine automatique votre commande ou vous propose des suggestions. Si la saisie semi‐automatique est activée, vous pouvez demander à twilio-cli
de vous indiquer ces suggestions en appuyant sur la touche de validation (généralement Tab
dans la plupart des shells).
Activez la commande de saisie semi‐automatique pour twilio-cli
en exécutant la commande appropriée pour votre shell :
twilio autocomplete bash
twilio autocomplete zsh
Suivez les instructions qui s'affichent, puis redémarrez votre shell ou ouvrez‐en un nouveau pour terminer l'installation de la saisie semi‐automatique des commandes.
Si aucune suggestion ne s'affiche, vérifiez que vous avez redémarré votre shell ou ouvert une nouvelle instance depuis l'installation.
Explorer twilio-cli
La meilleure façon de découvrir ce que vous pouvez faire avec twilio-cli
est d'exécuter la commande :
twilio
Vous obtiendrez alors une liste des différentes rubriques et commandes que vous pouvez exécuter. Les rubriques regroupent elles‐mêmes différentes rubriques et commandes, de la même manière que la structure des dossiers de votre système de fichiers.
$ twilio
Libérez la puissance de Twilio à partir de votre invite de commande. Consultez le site https://twil.io/cli pour obtenir de la documentation.
VERSION
twilio-cli/3.0.0 darwin-x64 node-v16.13.1
UTILISATION
$ twilio [COMMANDE]
RUBRIQUES
api accès avancé à toutes les API de Twilio
config permet de gérer les configurations CLI de Twilio
debugger affiche la liste des événements de journal générés pour le compte
email envoie des e‐mails à un ou plusieurs destinataires à l'aide de Twilio SendGrid
feedback fournit des commentaires à l'équipe CLI
numéros de téléphone permet de gérer les numéros de téléphone Twilio
plugins répertorie les plug‐ins disponibles pour l'installation
profiles permet de gérer les informations d'identification des profils Twilio
COMMANDES
autocomplete affiche les instructions d'installation pour la saisie semi‐automatique
feedback fournit des commentaires à l'équipe CLI
help affiche l'aide de Twilio
login crée un profil pour stocker les informations d'identification et de configuration du compte Twilio
plugins répertorie les plug‐ins installés
update met à jour la CLI Twilio
Vous voyez quelque chose d'intéressant ? Essayez de l'exécuter :
twilio api
Étant donné que api
est une rubrique, vous verrez davantage de rubriques et de commandes contenues dans cette rubrique. Supposons qu'au cours du processus d'exploration, vous rencontrez cette commande :
twilio api:core:messages:list
Si vous exécutez cette commande, elle va répertorier tous vos messages SMS, et il peut y en avoir beaucoup. Comment les filtrer ? Ou, plus généralement, comment découvrir les options fournies par une commande CLI donnée ? La réponse est d'ajouter --help
à la commande comme suit :
twilio api:core:messages:list --help
Si vous saisissez une commande, vous risquez d'obtenir une erreur si vous n'avez pas fourni toutes les options requises. Il s'agit d'une autre situation dans laquelle l'ajout de --help
à la commande peut vous donner plus d'informations.
Exemples
Répertorier vos numéros de téléphone
twilio phone-numbers:list
Envoyer un message texte
twilio api:core:messages:create \
--from "+15017122661" \
--to "+15558675310" \
--body "I love you 3000"
Plus d'exemples
Consultez notre page d'exemples pour découvrir une galerie d'exemples supplémentaires.
Et ensuite ?
Maintenant que vous avez été initié à twilio-cli
, que faire ?
Plus d'exemples
Consultez notre page d'exemples pour découvrir plus d'exemples des nombreuses fonctionnalités de twilio-cli
.
Explorer les modules complémentaires
twilio-cli
peut être enrichi par des plug‐ins. Vous pouvez publier les vôtres pour la communauté ou les rendre privés pour vos propres workflows métiers (ou ceux de vos clients). Un certain nombre de plug‐ins sont déjà disponibles pour vous permettre de développer votre CLI.
Guide d'utilisation générale
Reportez‐vous à notre guide d'utilisation générale pour en savoir plus sur les différentes fonctionnalités de la CLI :
- Stocker les informations d'identification dans des variables d'environnement
- Webhooks vers l'hôte local
- Différents formats de sortie
- Niveau des messages de journalisation
- Plusieurs comptes/profils
- Utiliser le certificat TLS de votre entreprise pour les requêtes d'API
- Diviser une commande twilio-cli en plusieurs lignes
Envoyez‐nous vos commentaires
Nous serions heureux d'avoir votre retour. Chaque fois que vous avez des commentaires que vous aimeriez nous envoyer, exécutez simplement :
twilio feedback
Besoin d'aide ?
Ça arrive à tout le monde, il est parfois difficile de coder. Obtenez de l'aide dès maintenant auprès de notre équipe d'assistance, ou appuyez‑vous sur la sagesse collective en visitant le collectif Stack Overflow Twilio ou en parcourant le tag Twilio sur Stack Overflow.