Skip to content
Index Inspector

/init

/init

Section titled “/init”

The /init command starts the process of setting up a new project for scanning. It provides a web-based form to capture all necessary project details.

Usage

Section titled “Usage”
/init

Example

Section titled “Example”

You send:

/init

Bot responds:

Please fill out this form to initiate your project:
[Link to Project Init Form]

Form Parameters

Section titled “Form Parameters”

The form will ask for:

  • Project Name: A descriptive name for your project.
  • Git URL: The repository URL of your project code.
  • Scan Paths: Comma-separated paths within the repo to scan (e.g., app, modules). No trailing slash required.
  • Framework: The framework used (e.g., Laravel, Node.js).
  • Database: The database engine (e.g., PostgreSQL, MySQL).
  • Migration Git URL: (Optional) URL for migrations if they are in a separate repo.
  • Migration Scan Paths: The directory where migration files are located (e.g., database/migrations). Similar to scan paths, no trailing slash is needed. This is used to extract your existing index schema so the bot doesn’t recommend indexes you already have.
  • Index Scan Method: Choose between scanning migration files or CSV exports.

Notes

Section titled “Notes”
  • Ensure the bot has proper access permissions to any private Git URLs you provide.
  • The link provided is unique to your session and should not be shared.