/scan

/scan

The /scan command is the core feature of Index Inspector. It triggers the analysis of your codebase for the specified branch and provides indexing recommendations.

Usage

/scan <branch_name> [project_id]

Parameters

Parameter	Required	Description
branch_name	Yes	The Git branch you want to scan (e.g., main, develop, feature/optimization).
project_id	No	Required only if you have more than one project. Specifies which project to scan.

Example

You send:

/scan main 45

Bot responds:

Scanning project 'My Awesome API' on branch 'main'...
━━━━━━━━━━━━━━━━━━━━━━━━━━
Scan Complete! ✅
Found 12 queries.
Recommended Indexing: 3 new indexes.

Use /result 45 to see details or /result_migration to get the migration file.

Notes

• Branch Selection: For the best coverage and architectural context, scanning stable branches like main, production, or development is recommended.
• Incremental Scanning: Index Inspector detects changes based on your commit history. When you run a scan, you will be asked if you want to perform a Full Scan or a Partial Scan (only files that have changed).
• Scanning can take anywhere from a few seconds to a minute depending on the size of your codebase and the scan type chosen.
• Results are automatically saved and can be retrieved later using /result.