Skip to main content
The create-instantsearch-app CLI supports multiple templates across web and mobile platforms.

​
Web Templates

​
InstantSearch.js

Vanilla JavaScript template using InstantSearch.js.
​
Template name
string
InstantSearch.js
​
Library
string
instantsearch.js
​
Supported versions
string
= 3.0.0 < 5.0.0
Features:
  • Pure JavaScript, no framework required
  • Parcel bundler for development
  • TypeScript support
  • ESLint and Prettier configured
  • Dynamic Widgets (>= 4.30)
  • Insights support (>= 4.55)
  • Autocomplete integration (>= 4.52)
npx create-instantsearch-app my-app --template "InstantSearch.js"

​
React InstantSearch

React template using React InstantSearch.
​
Template name
string
React InstantSearch
​
Library
string
react-instantsearch
​
Supported versions
string
= 7.0.0 < 8.0.0
Features:
  • React 18+ support
  • Parcel bundler for development
  • ESLint and Prettier configured
  • Dynamic Widgets (>= 7.0)
  • Insights support (>= 7.0)
npx create-instantsearch-app my-app --template "React InstantSearch"

​
Vue InstantSearch

Vue 2 template using Vue InstantSearch.
​
Template name
string
Vue InstantSearch
​
Library
string
vue-instantsearch
​
Supported versions
string
= 3.0.0 < 5.0.0
Features:
  • Vue 2 framework
  • Parcel bundler for development
  • ESLint and Prettier configured
  • Dynamic Widgets (>= 4.2.0)
  • Insights support (>= 4.9.0)
npx create-instantsearch-app my-app --template "Vue InstantSearch"

​
Vue InstantSearch with Vue 3

Vue 3 template using Vue InstantSearch.
​
Template name
string
Vue InstantSearch with Vue 3
​
Library
string
vue-instantsearch
​
Supported versions
string
= 4.0.0 < 5.0.0
Features:
  • Vue 3 framework with Composition API
  • Parcel bundler for development
  • ESLint and Prettier configured
  • Dynamic Widgets support
  • Insights support
npx create-instantsearch-app my-app --template "Vue InstantSearch with Vue 3"

​
Autocomplete

Standalone Autocomplete template using Autocomplete.js.
​
Template name
string
Autocomplete
Features:
  • Autocomplete.js library
  • Query Suggestions plugin
  • Recent Searches plugin
  • Parcel bundler
npx create-instantsearch-app my-app --template "Autocomplete"

​
Mobile Templates

​
React InstantSearch Native

React Native template for mobile apps.
​
Template name
string
React InstantSearch Native
Features:
  • React Native framework
  • Expo for development
  • iOS and Android support
  • TypeScript support
npx create-instantsearch-app my-app --template "React InstantSearch Native"

​
InstantSearch iOS

Native iOS template using InstantSearch iOS.
​
Template name
string
InstantSearch iOS
Features:
  • Swift-based
  • Xcode project structure
  • CocoaPods for dependencies
  • Native iOS widgets
npx create-instantsearch-app my-app --template "InstantSearch iOS"

​
InstantSearch Android

Native Android template using InstantSearch Android.
​
Template name
string
InstantSearch Android
Features:
  • Kotlin-based
  • Gradle build system
  • Android Studio compatible
  • Native Android widgets
npx create-instantsearch-app my-app --template "InstantSearch Android"

​
Advanced Templates

​
JavaScript Client

Low-level template using only the Algolia JavaScript client.
​
Template name
string
JavaScript Client
Use case: Build custom search UIs without InstantSearch widgets 
npx create-instantsearch-app my-app --template "JavaScript Client"

​
JavaScript Helper

Template using the Algolia Search Helper.
​
Template name
string
JavaScript Helper
Use case: More control than widgets, easier than the raw client 
npx create-instantsearch-app my-app --template "JavaScript Helper"

​
InstantSearch.js widget

Template for creating custom InstantSearch.js widgets.
​
Template name
string
InstantSearch.js widget
Use case: Build and publish custom widgets to npm 
npx create-instantsearch-app my-widget --template "InstantSearch.js widget"

​
Template Features Comparison

TemplateDynamic WidgetsInsightsAutocomplete
InstantSearch.js>= 4.30>= 4.55>= 4.52
React InstantSearch>= 7.0>= 7.0-
Vue InstantSearch>= 4.2.0>= 4.9.0-
Vue InstantSearch (Vue 3)>= 4.2.0>= 4.9.0-
AutocompleteN/AN/ABuilt-in
React InstantSearch Native---
Dynamic Widgets automatically renders filters based on your index configuration.Insights enables event tracking for analytics and personalization.Autocomplete provides enhanced search input with suggestions.

​
Choosing a Template

For simple projects

Use InstantSearch.js for lightweight, framework-free search

For React apps

Use React InstantSearch for seamless React integration

For Vue 2 apps

Use Vue InstantSearch for Vue 2 projects

For Vue 3 apps

Use Vue InstantSearch with Vue 3 for modern Vue

For mobile apps

Use React InstantSearch Native, iOS, or Android templates

For custom widgets

Use InstantSearch.js widget template

Build docs developers (and LLMs) love

Get started for freeTalk to us