Meilisearch Setup

You are a backend developer setting up Meilisearch. The user wants to install, configure, and index data in Meilisearch for fast typo-tolerant search.

What to check first

• Ensure you have Docker installed (docker --version) or download from meilisearch.com/downloads for your OS
• Verify Node.js is installed (node --version) if using the JavaScript SDK
• Check that port 7700 is available (lsof -i :7700 on macOS/Linux or netstat -ano | findstr :7700 on Windows)

Steps

1. Start Meilisearch server using Docker with docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest meilisearch --master-key=your-master-key
2. Install the Meilisearch JavaScript client: npm install meilisearch
3. Create a Meilisearch client instance pointing to http://localhost:7700 with your master key
4. Create an index by calling client.createIndex('books') with a unique indexUid
5. Configure typo tolerance by setting typoTolerance settings on the index to enable it and set maxDiatones and minWordSizeForTypos
6. Add documents to the index using index.addDocuments() with an array of objects containing id and searchable fields
7. Wait for the task to complete by checking the task status returned from document addition
8. Test search with index.search('query') to verify typo tolerance works

Code

import { MeiliSearch } from 'meilisearch';

const client = new MeiliSearch({
  host: 'http://localhost:7700',
  apiKey: 'your-master-key',
});

async function setupMeilisearch() {
  try {
    // Create index
    const indexUid = 'books';
    const index = await client.createIndex(indexUid, { primaryKey: 'id' });
    console.log('Index created:', index);

    // Configure typo tolerance
    await index.updateSettings({
      typoTolerance: {
        enabled: true,
        minWordSizeForTypos: {
          oneTypo: 5,
          twoTypos: 9,
        },
      },
      searchableAttributes: ['title', 'author', 'description'],
      displayedAttributes: ['id', 'title', 'author', 'year'],
    });

    // Add documents
    const documents = [
      { id: 1, title: 'The Great Gatsby', author: 'F. Scott Fitzgerald', year: 1925 },
      { id: 2, title: '1984', author: 'George Orwell', year: 1949 },
      { id: 3, title: 'To Kill a Mockingbird', author: '

Note: this example was truncated in the source. See the GitHub repo for the latest full version.

Common Pitfalls

• Treating this skill as a one-shot solution — most workflows need iteration and verification
• Skipping the verification steps — you don't know it worked until you measure
• Applying this skill without understanding the underlying problem — read the related docs first

When NOT to Use This Skill

• When a simpler manual approach would take less than 10 minutes
• On critical production systems without testing in staging first
• When you don't have permission or authorization to make these changes

How to Verify It Worked

• Run the verification steps documented above
• Compare the output against your expected baseline
• Check logs for any warnings or errors — silent failures are the worst kind

Production Considerations

• Test in staging before deploying to production
• Have a rollback plan — every change should be reversible
• Monitor the affected systems for at least 24 hours after the change