Viam SDK
Viam TypeScript SDK
Build and connect to robots with TypeScript
(In)stability Notice
Warning This is a beta release of the Viam TypeScript SDK. Stability is not guaranteed. Breaking changes are likely to occur, and occur often.
Usage
Installation
npm install @viamrobotics/sdk
Examples
The examples directory contains small apps that demonstrate how to use this SDK to operate a robot running Viam.
Documentation
Node
To use this SDK with node, read the documentation or view the example
React Native
To use this SDK with React Native, read the documentation or view the example
Offline Mode
Warning
Using the typescript SDK in offline mode necessitates disabling TLS verification and so should be done with caution.
To use the browser on a local network with limited-or-no internet, follow these instructions:
1. start viam-server with the `-no-tls` flag
2. set the signaling server in typescript to `http://{HOST}.local:8080`
License
Copyright 2022-2025 Viam Inc.
Apache 2.0 - See LICENSE file