Skip to main content
CodeCompass

How it works

No account needed to read this page. To use the product you sign in, point the app at a codebase it can read, then search or chat.

Walkthrough video

Short sample clip (CC0). Replace with your own recording by setting NEXT_PUBLIC_TOUR_VIDEO_URL to an MP4 URL.

  1. 1

    Create an account

    One login for your workspace. There is no separate "team" product.

  2. 2

    Index a repository

    The app runs on a server you (or your host) control. You either give a folder path that server can read or a git URL to clone. Large repos may hit a file cap; the dashboard tells you if that happens.

    Setup: analyze

    /var/projects/my-app

    → Analyze → indexed files appear in Workspace

  3. 3

    Search, viewer, or chat

    Search uses the index. Chat needs your AI API keys in Settings. The demo viewer is a sandbox, not a full IDE.

    Search

    auth · 12 matches

    Chat

    Where is auth handled?

    → Answer uses indexed files…

What you need

  • An account
  • A repo path or URL the server can access
  • Optional: API keys if you want AI chat (you pay the provider)

← Back to home · Pricing