{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/functions/cli/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["partial"]},"type":"markdown"},"seo":{"title":"sinch upgrade | Sinch CLI | Sinch","siteUrl":"https://developers.sinch.com","llmstxt":{"title":"Sinch Developer Documentation","description":"LLMs.txt containing a map of all the documentation files for Sinch.","sections":[{"title":"Numbers API","description":"The Numbers API enables you to search for, view, and activate numbers. It's considered a precursor to other APIs in the Sinch product family. The numbers API can be used in tandem with any of our APIs that perform messaging or calling.","includeFiles":["docs/numbers/**/*.md","docs/numbers/**/*.yaml"],"excludeFiles":["docs/numbers/index.md"]},{"title":"Conversation API","description":"Send and receive messages globally on SMS, RCS, WhatsApp, and other channels with Sinch's Conversation API. Conversation API is the API to use for all new SMS integrations with Sinch; its SMS channel replaces the standalone SMS REST API, which reached end of sale on 15 April 2026. Conversation API has unified error messages, consistent request payloads, and channel-agnostic webhook payloads.","includeFiles":["docs/conversation/**/*.md","docs/conversation/**/*.yaml"],"excludeFiles":["docs/conversation/index.md"]},{"title":"Standalone SMS REST API (end of sale, existing integrations only)","description":"The standalone SMS REST API reached end of sale on 15 April 2026 and is no longer available to new customers. All new SMS integrations must use the SMS channel of Conversation API (https://developers.sinch.com/docs/conversation/channel-support/sms/). Use these pages only to maintain an existing standalone SMS REST API integration, or to migrate it to Conversation API.","includeFiles":["docs/sms/**/*.md","docs/sms/**/*.yaml"],"excludeFiles":["docs/sms/index.md","docs/sms/**/md_snippets/**"]},{"title":"Voice API (legacy/GA)","description":"Which Voice API? If you are building something using voice AI agents, use the Voice API v2. To learn more, you can read [Why migrate to v2?](/docs/voice-2.0/migration.md) or [What's new?](/docs/voice-2.0/whatsnew.md).\n\nThe Voice API works as a big telephony switch. The Voice API handles incoming phone calls (also known as incoming call “legs”), sets up outgoing phone calls (or outgoing call “legs”), and bridges the two. The incoming call leg may come in over a data connection (from a smartphone or web application using the Sinch SDKs) or through a local phone number (from the PSTN network). Similarly, the outgoing call leg can be over data (to another smartphone or web application using the Sinch SDKs) or the PSTN network.","includeFiles":["docs/voice/**/*.md"],"excludeFiles":["docs/voice/index.md"]},{"title":"Voice API v2 (recommended for new builds/preview)","description":"Which Voice API? If you are building something using voice AI agents, use the Voice API v2. To learn more, you can read [Why migrate to v2?](/docs/voice-2.0/migration.md) or [What's new?](/docs/voice-2.0/whatsnew.md).\n\nThe Voice API v2 enables embedding voice calling into applications for virtually limitless use cases. From voice-enabling AI agents to allow real-time conversational AI workflows over the phone, to number masking for privacy, automated appointment reminders, and outreach campaigns with answering machine detection, to bridging calls between PSTN and SIP endpoints, the API offers the flexibility and control needed for modern communications. The Sinch Programmable Voice is a cloud-native global voice platform, composed by multiple Inbound and Outbound voice channels. All these channels can be combined using our powerful markup language called SVAML v2, creating a toolbox capable of building almost limitless use cases. Our SVAML uses the concept of commands, and customers can use a combination of our commands to interact with calls in all channels, in order to model from the most basic to highly complex scenarios, required to fulfill their voice calling needs.","includeFiles":["docs/voice-2.0/**/*.md"],"excludeFiles":["docs/voice-2.0/index.md"]},{"title":"Verification API","description":"The Verification API is a platform for phone number verification. It consists of the API and different software development kits (the Sinch SDKs) that you integrate with your smartphone or web application and cloud based back-end services. Together they enable SMS, Flashcall, Phone Call and Data verification in your application.","includeFiles":["docs/verification/**/*.md","docs/verification/**/*.yaml"],"excludeFiles":["docs/verification/index.md"]},{"title":"Provisioning API","description":"Provisioning API allows you to programmatically set up your senders, accounts and templates on your favorite messaging platforms on the Conversation API. For now, you can create your first WhatsApp channel through Meta's Embedded sign up, you can configure your first SMS App and configure your webhooks. As development continues, we will be adding the most commonly used channels.","includeFiles":["docs/provisioning-api/**/*.md","docs/provisioning-api/**/*.json"],"excludeFiles":["docs/provisioning-api/index.md"]},{"title":"Elastic SIP Trunking API","description":"With Elastic SIP Trunking you can create and manage your SIP trunks and phone numbers programmatically.","includeFiles":["docs/est/**/*.md","docs/est/**/*.yaml"],"excludeFiles":["docs/est/index.md"]},{"title":"Fax API","description":"Send and receive HIPAA compliant faxes on our modern fax platform using our developer-friendly API.","includeFiles":["docs/fax/**/*.md","docs/fax/**/*.yaml"],"excludeFiles":["docs/fax/index.md"]},{"title":"In-app Voice and Video SDK","description":"The In-app Voice and Video SDK enables you to add voice and video calling capabilities directly into your mobile or web application using the Sinch SDKs.","includeFiles":["docs/in-app-calling/**/*.md"],"excludeFiles":["docs/in-app-calling/index.md"]},{"title":"Number Lookup API","description":"The Number Lookup API is designed to provide in-depth information about phone numbers, helping enterprises enhance their communication strategies and prevent fraud. By identifying the type of phone line (for example, mobile, landline, VoIP) and the associated carrier, the API allows businesses to optimize routing, reduce unnecessary costs, and improve customer engagement.","includeFiles":["docs/number-lookup-api-v2/**/*.md","docs/number-lookup-api-v2/**/*.yaml"],"excludeFiles":["docs/number-lookup-api-v2/index.md"]},{"title":"Functions","description":"Serverless compute for voice and messaging. Deploy your code and Sinch routes live calls and messages to it — no infrastructure to run.","includeFiles":["docs/functions/functions/**/*.md","docs/functions/concepts/**/*.md","docs/functions/ai-support.md","docs/functions/reference/**/*.md"],"excludeFiles":["docs/functions/functions/index.md"]},{"title":"CLI","description":"One command line for Sinch numbers, messaging, voice, fax, SIP trunking and porting, and the full Functions lifecycle — scaffold, run locally, deploy, and manage.","includeFiles":["docs/functions/cli/**/*.md"],"excludeFiles":["docs/functions/cli/index.md"]}]},"description":"Check for a newer Sinch CLI and install it, and see what the auto-updater knows."},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"sinch-upgrade","__idx":0},"children":["sinch upgrade"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Check for a newer Sinch CLI and install it. Auto-update is off by default; see"," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/functions/cli/installation#updating"},"children":["Updating"]}," for how it works."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"sinch-upgrade-1","__idx":1},"children":["sinch upgrade"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Check the registry now and act on the result."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"sh","header":{"controls":{"copy":{}}},"source":"sinch upgrade\n","lang":"sh"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Unlike the background check that runs on every command, this ignores the 30-minute rate limit and"," ","the CI/non-TTY suppression, because you asked for it explicitly. It reports one of:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Message"},"children":["Message"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Meaning"},"children":["Meaning"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Already on the latest version"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Nothing to do"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Update queued. It will install in the background..."]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A helper is installing it; effective on a later run"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Auto-update is off. Enable it with: sinch config set autoUpdate true"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An update exists but you have not opted in"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["This update crosses a minor version boundary..."]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Pre-1.0 the minor is where breaking changes live; update by hand when ready"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["This CLI was not installed by npm globally..."]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update it the way you installed it"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Automatic installs are paused for this release"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Paused centrally; update by hand if you need it now"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["The published version has no provenance attestation"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Will not be installed automatically"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Could not reach the npm registry"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transient; try later"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"sinch-upgrade---status","__idx":2},"children":["sinch upgrade --status"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Show what the CLI knows, without touching the network."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"sh","header":{"controls":{"copy":{}}},"source":"sinch upgrade --status\n","lang":"sh"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Version:      0.5.8\nAuto-update:  on\nLast checked: 2026-09-01T20:51:25.806Z\nPending:      0.5.9\nFailures:     1\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Pending"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Failures"]}," appear only when an install is in flight or has been failing. After three"," ","consecutive failures for the same version the CLI stops trying and falls back to notifying you."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Install output is appended to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["~/.sinch/update.log"]},", which is the first place to look if an update"," ","is not landing."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"json-output","__idx":3},"children":["JSON output"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Both forms accept ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--json"]}," and print a single JSON document to stdout with no other output."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"sh","header":{"controls":{"copy":{}}},"source":"sinch upgrade --status --json\n","lang":"sh"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"version\": \"0.5.8\",\n  \"autoUpdate\": true,\n  \"lastCheckedAt\": \"2026-09-01T20:51:25.806Z\",\n  \"pending\": \"0.5.9\",\n  \"consecutiveFailures\": 1\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastCheckedAt"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]}," when the CLI has never checked. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pending"]}," is omitted when there is no"," ","target."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"sh","header":{"controls":{"copy":{}}},"source":"sinch upgrade --json\n","lang":"sh"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{ \"version\": \"0.5.8\", \"outcome\": \"up-to-date\" }\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["outcome"]}," is one of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["up-to-date"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["spawned"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["skipped-in-flight"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["skipped-disabled"]},","," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["skipped-ineligible"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["skipped-not-global"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["skipped-killswitch"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["skipped-suppressed"]},","," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["skipped-rate-limited"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["failed"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"see-also","__idx":4},"children":["See also"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/functions/cli/installation#updating"},"children":["Updating"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/functions/cli/configuration"},"children":["Configuration"]}," for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["autoUpdate"]}," and the environment variables"]}]}]},"headings":[{"value":"sinch upgrade","id":"sinch-upgrade","depth":1},{"value":"sinch upgrade","id":"sinch-upgrade-1","depth":2},{"value":"sinch upgrade --status","id":"sinch-upgrade---status","depth":2},{"value":"JSON output","id":"json-output","depth":2},{"value":"See also","id":"see-also","depth":2}],"frontmatter":{"seo":{"title":"sinch upgrade | Sinch CLI | Sinch","description":"Check for a newer Sinch CLI and install it, and see what the auto-updater knows."}},"lastModified":"2026-10-12T21:36:30.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/functions/cli/commands/upgrade","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}