Quickstart

Do these in order.

You only need to replace one value:

• YOUR_API_KEY

Local demo shortcut

If you are grading or showing the deployed project, the easiest path is:

curl -fsSL https://indexlane.com/demo.sh | bash

That hosted script uses the built-in fake workspace and runs the seeded demo flow end to end. The browser version lives at /demo.

1. In the web app

• Sign in.
• Connect the providers you want to search.
• Open Account and create a personal API key.
• Copy the key immediately.

2. Install the CLI

curl -fsSL https://indexlane.com/install | bash

If you prefer a direct package install instead of the shell script:

npm install -g https://indexlane.com/downloads/index-lane.tgz

3. Log in

index-lane login --base-url https://indexlane.com --api-key YOUR_API_KEY

4. Check the connection

index-lane providers list
index-lane providers resources gmail
index-lane providers access get gmail

If you use a provider other than Gmail first, swap gmail for notion, google-drive, calendar, slack, or github.

5. Search

index-lane search "launch notes"

6. Fetch one result

index-lane get RESULT_ID

Use the id returned by search.

7. Optional: run MCP

index-lane mcp serve

If something fails

• Unauthorized: your API key is wrong or your --base-url points at the wrong deployment.
• Empty provider list: nothing is connected in the web app yet.
• Empty search results: the provider access rules exclude the item you expected.