Skip to main content
Version: 2.x.x

Templates

Use vsdk templates to discover and inspect VideoSDK starter projects before creating an application.

List available templates​

Each starter project has a unique Template ID, such as react. You can use this ID to inspect a template or create a new application from it.

To view the available templates:

vsdk templates
Example output

The following example shows a subset of the available React templates. Other platforms are omitted for brevity.

  FEATURE                     ID          REPOSITORY

React
Video calling react videosdk-rtc-react-sdk-example
Interactive live streaming ils-react videosdk-ils-react-sdk-example
HLS live streaming hls-react videosdk-hls-react-sdk-example

The ID is the value you use with other CLI commands.

Filter the list​

Narrow the list by use case, by platform, or both:

vsdk templates --category ils
vsdk templates --platform flutter
OptionDescription
--category <category>Show one use case: rtc (video calling), ils (interactive live streaming) or hls (HLS live streaming).
--platform <platform>Show one platform: react, javascript, react-native, flutter, android or ios.
--allAlso list templates that are switched off while their example repository is being fixed.

View template details​

Use a Template ID to inspect the configuration and requirements for a specific starter project.

For example, to view the React video calling template:

vsdk templates react

The template details include:

  • VideoSDK token configuration
  • Required tools
  • Dependency installation command
  • Application run command
Example output
TOKEN     token written to .env as REACT_APP_VIDEOSDK_TOKEN
NEEDS node, git, npm
INSTALL npm install
RUN npm start → http://localhost:3000

Create an application from a template​

Once you have selected a template, use its Template ID with vsdk init to create a new application.

Pass the Template ID as the first argument and the project directory as the second:

vsdk init react my-app

The project directory must be new or empty. An existing .git folder is allowed.

During setup, the CLI can prompt you for credentials and provides options to install dependencies and launch the application.

For the complete project creation flow, see Create a project.

JSON output​

Use the --json option when working with scripts or AI coding agents. This returns template information as structured JSON.

vsdk templates --json

This makes it easier to process template information programmatically.

Get help​

To view the available options for the templates command:

vsdk templates --help

Got a Question? Ask us on discord