Skip to main content
create-instantsearch-app is a command-line utility that helps you quickly scaffold InstantSearch applications using any Algolia InstantSearch flavor.

​
What is it?

The CLI generates production-ready InstantSearch applications with:
  • Pre-configured search UI components
  • Best practices built-in
  • Multiple framework support (JavaScript, React, Vue, Angular)
  • Interactive setup or automated configuration
  • TypeScript support (where applicable)

​
Quick Start

Create a new InstantSearch app in seconds: 
npx create-instantsearch-app my-app
cd my-app
npm start

​
Requirements

  • Node.js >= 10
  • npm >= 5.2.0 (for npx) or Yarn >= 1.0

​
Features

Interactive Mode

Guided setup with prompts for all configuration options

Multiple Templates

Support for InstantSearch.js, React, Vue, Angular, iOS, and Android

Automated Setup

Use config files to automate app generation

Algolia Integration

Connect to your Algolia index with search API key

​
Package Info

​
version
string
7.5.41
​
license
string
MIT
​
repository
string
algolia/instantsearch

​
What Gets Generated?

When you create a new app, you get:
  • A complete search interface with widgets (search box, hits, filters)
  • Package configuration with all dependencies
  • Development server setup
  • Build scripts for production
  • ESLint and Prettier configuration
  • TypeScript configuration (for TS templates)

​
Next Steps

Usage Guide

Learn about CLI flags and interactive mode

Templates

Explore available templates for different frameworks

Configuration

Configure apps using config files

Build docs developers (and LLMs) love

Get started for freeTalk to us