Skip to content
Last updated

Installation

Requirements

RequirementVersion / Notes
Operating systemWindows 10+, macOS 12+, Linux (any modern distro)

For Node.js functions, you also need Node.js 20+. For C# functions, you need .NET 9 SDK or later.

Install the Sinch CLI

npm install -g @sinch/cli

Install takes a few seconds. It handles PATH setup and shell completions automatically.

If you don't already have Node.js, install Node.js 20+ first — npm comes with it.

Verify:

sinch --version

Authenticate

sinch auth login

Enter your Project ID, Key ID, and Key Secret from the Sinch Dashboard under your project's Access Keys section.

Key secrets are stored in your OS keychain (Windows Credential Manager, macOS Keychain, or Linux Secret Service). Short-lived session tokens are stored in your local config (~/.sinch/).

For voice templates, you can optionally provide a Voice Application Key and Secret. The CLI will prompt for these when needed.

Shell completions

Tab completions install automatically when you run npm install -g @sinch/cli.

If completions are missing or you want to force a reinstall:

sinch completion --install

To print the completion script to stdout (e.g. for custom setups):

sinch completion --shell bash    # Bash
sinch completion --shell zsh     # Zsh
sinch completion --shell powershell  # PowerShell

Updating

npm update -g @sinch/cli

The Sinch CLI checks for new versions automatically and prints a notice when one is available.

Uninstalling

npm uninstall -g @sinch/cli
sinch auth logout  # remove stored credentials