Skip to main content
The hosted version of Waterline at getwaterline.dev gives you everything you need to start analyzing ticket progress: LLM API keys, database, vector store, and cache are all provided. You only need to connect your GitHub repository and your issue tracker.

​
Sign up and create a workspace

1

Create an account

Go to app.getwaterline.dev/auth and sign up with your email and password.
2

Create a workspace

After signing up, you’ll land in the onboarding flow. Create a workspace — typically your organization or project name. You can invite teammates to the same workspace later.

​
Connect a repository

1

Authorize GitHub

From the dashboard, click Connect GitHub. You’ll be redirected to GitHub to authorize the Waterline app. Select which repositories Waterline should have access to.
2

Select a repository

Back in Waterline, pick the specific repository to connect to your workspace. Waterline registers a webhook and starts indexing immediately.
3

Wait for initial indexing

The initial index crawls every source file and extracts function and class-level symbols. You can watch progress in the UI. For most repositories, indexing completes in 5–15 minutes.
Waterline indexes source code files only. Binary files, lock files, node_modules, and other non-source paths are excluded automatically.

​
Connect your issue tracker

​
Jira

Click Connect Jira in Settings → Integrations. You’ll go through the Atlassian OAuth flow and grant Waterline read access to your Jira projects. No admin permissions are needed — Waterline only reads issue summaries, descriptions, and acceptance criteria.

​
GitHub Issues

If your repository is already connected, go to Settings → Integrations and toggle on GitHub Issues. Waterline uses GitHub’s issue API directly — no separate OAuth is required.

​
Analyze a ticket

Once indexing is complete, you’re ready to run your first analysis.
1

Open the Analyze page

Click Analyze in the sidebar.
2

Enter a ticket reference

Type a Jira ticket key (e.g. PROJ-123) or a GitHub Issue number.
3

Select the repository

Choose the repository to search against and click Analyze.
4

Review the results

Results arrive in seconds for cached analyses, or 10–30 seconds for a fresh run. You’ll see:
  • Overall progress % — the deterministic completion score
  • Per-criterion breakdown — SATISFIED, PARTIAL, or UNSATISFIED for each acceptance criterion
  • Evidence list — the specific functions and classes that support each criterion, with relevance scores

​
Keeping the index fresh

Waterline registers a GitHub webhook when you connect a repository. Every push to any branch triggers an incremental re-index of changed files only. You don’t need to manually sync — the index stays current automatically.

​
Pricing

The hosted version is free during the beta. Team plans with higher usage limits are available — see getwaterline.dev for current pricing.
If you’d rather run Waterline on your own infrastructure and bring your own LLM keys, see the self-hosted quickstart.