Skip to content

sinch config

Manage CLI configuration and credential profiles. Configuration is stored in ~/.sinch/config.json. Profile-specific credentials are stored in the OS keychain.

sinch config set

Set a configuration value.

sinch config set <key=value>
sinch config set fax <key=value>

--json prints { "key": "projectId", "value": "abc" }. Fax keys are reported as fax.serviceId and fax.senderNumber. Bad input prints an error document and exits 1.

Valid fax config keys: serviceID (alias: service-id), senderNumber (alias: sender-number).

sinch config get

Read a configuration value.

sinch config get <key>
sinch config get fax <key>

--json prints { "key": "...", "value": "..." }. value is left out when the key is not set.

sinch config list

Show all current configuration values for the active profile.

sinch config list

--json prints { profile, config, fax? }. config holds the values the text output shows, with credentials shown as (secure). fax appears only when a fax value is set.

sinch config profile

Manage credential profiles for working across multiple Sinch projects. Each profile stores its own credentials in the keychain.

sinch config profile list

sinch config profile list

--json prints { "profiles": [{ name, projectId?, keyId?, active }] }.

sinch config profile create

sinch config profile create <name>

--json prints { name, created: true }. It does not offer to switch to the profile or log in; run profile use and auth login for that.

sinch config profile use

sinch config profile use <name>

--json prints { name, active: true }.

sinch config profile delete

sinch config profile delete <name> [-f, --force]

-f, --force skips the confirmation prompt. --json prints { name, deleted: true } and requires --force; without it the command fails with an error document naming --force.

sinch health

Check connectivity to the SinchFunctions API.

sinch health

--json prints the health response unchanged, for example { "status": "healthy" }. A failure prints an error document and exits with the mapped code (503 gives 69, for example).

sinch completion

Generate shell completion scripts for tab completion.

sinch completion [options]
OptionDescription
--shell <shell>Shell type: powershell, bash, or zsh (auto-detected if omitted)
--installForce reinstall completion into the current shell's profile

The CLI refreshes completions silently on startup and prints a one-time hint on first run. To install completions into your shell profile or print the script:

sinch completion --install           # Reinstall into shell profile
sinch completion --shell bash        # Print bash completion to stdout
sinch completion --shell powershell  # Print PowerShell completion to stdout
We'd love to hear from you!
Rate this content: