README.md

Firestore Indexes Diff

Display differences between two Firestore indexes config files

Table of Contents

• Firestore Indexes Diff
  • Table of Contents
• Prerequisites
• Usage
  • With npx
  • With npm
• Available Options

Prerequisites

• Make sure to have the indexes files ready. Refer to Cloud Firestore Index Definition Reference to see how you can export them

Usage

• Don't forget to star this repo 😉

With npx

npx firestore-indexes-diff --source dev.json --target prod.json

With npm

1- Install the library

• npm

 npm install -g firestore-indexes-diff

or

• yarn

 yarn global add firestore-indexes-diff

2- Execute command

diff-indexes --source dev.json --target prod.json

Available Options

• source: string - Source indexes file path with extension

  • alias: s
  • required

• target: string - Target indexes file path with extension

  • alias: t
  • required