@sinch/cli
v0.8.1
Published
Official Sinch CLI - Manage all Sinch products from your terminal
Maintainers
Keywords
Readme
Sinch CLI
The Sinch CLI builds, tests and deploys Sinch Functions from your terminal, and manages the Sinch resources those functions use: phone numbers, voice services, SIP trunks, conversation apps.
github.com/sinch/cli is the public home for the CLI: releases, the changelog, the issue tracker and the function templates.
Install
npm install -g @sinch/cli
sinch --helpRequires Node.js 20 or later. @sinch/cli is a small launcher; npm picks the binary for your platform (Linux x64 and arm64, macOS Intel and Apple Silicon, Windows x64) as an optional dependency, so do not install with --omit=optional. Update later with sinch upgrade.
Standalone binaries for each platform are attached to every release, with a SHA256SUMS file. They are not code-signed yet, so macOS and Windows block the first run until you allow it.
Quick start
sinch auth login # authenticate once, credentials go to your OS keychain
sinch functions init # pick a template, scaffold a project
cd my-function
sinch functions dev # run locally, hot reload, optional tunnel for webhooks
sinch functions deploy # build and deploy to Sinch
sinch functions logs <id> --follow # stream logs from the deployed functionWhat it does
| Area | Commands | What for |
| --------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| Functions | sinch functions init / dev / deploy / list / logs / status / delete | The full lifecycle of a serverless function, Node.js or C#, from template to production |
| Secrets and env | sinch secrets, sinch env | Secrets in your OS keychain locally, injected into the function on deploy |
| Templates | sinch templates list | Browse starter templates: IVRs, call forwarding, SMS autoresponders, chatbots, AI voice agents |
| Numbers | sinch numbers | Search, rent and configure phone numbers, with pickers for the service plan, campaign and voice app |
| Voice | sinch voice v2 calls / services | Voice API v2: place and inspect calls, manage the services that route inbound calls |
| SIP | sinch sip trunks / endpoints | Elastic SIP trunking |
| Conversation | sinch conversations | Conversation API apps and webhooks |
| Fax, porting | sinch fax, sinch porting | Fax services and number porting |
| Profiles | sinch config profile, --profile <name> | Several Sinch projects or accounts side by side |
| CI | --json, --non-interactive | Scriptable output and no prompts for pipelines |
Every command has --help. Full reference: Sinch Functions documentation.
Issues
Open an issue for CLI bugs and feature requests. Vote with a thumbs-up reaction rather than a "+1" comment.
Issues are triaged by the CLI team into our internal tracker. The public issue stays the place where we talk to you about it, and we close it with a note when the fix ships.
Not a CLI issue? Questions about Sinch products themselves (SMS, Numbers, Voice, Conversation API, billing, account access) are answered faster elsewhere:
- Product documentation: https://developers.sinch.com/
- Sinch Functions documentation: https://developers.sinch.com/docs/functions
- Support: https://support.sinch.com/
Security
Do not report security issues in the issue tracker. See SECURITY.md.
License
The CLI is under the MIT License.
