Quick Start Guide

QEEK is currently invite-only. When you receive a beta invitation email, open the link — it takes you to my.qeek.ai/beta-signup with your invitation token.

1. 1Confirm your invitation email (shown as a read-only field).
2. 2Create a password, or choose Sign up with Google / Sign up with GitHub. The OAuth email must match the invitation.
3. 3Click Create Account & Join Beta.
4. 4On success, click Get started to open your projects.

Returning users sign in at my.qeek.ai/login with email/password, Google, or GitHub. Don't have an invite yet? Join the waitlist.

After signup you land on your projects page. If you have no projects yet, you'll see the onboarding showcase: connect GitHub, create a project, then wait for indexing.

1. 1Click Connect GitHub — it's free. Authorize QEEK with read access to your repositories (repo and read:user scopes). QEEK does not write to your repositories.
2. 2Click Create your first project. Give the project a name, then select one or more repos from Own Repositories or Public Repositories.
3. 3Click Create Project. You'll be taken to the welcome / indexing screen.
4. 4If needed, add a repository and click Start indexing (or Index all). Indexing typically completes in under 10 minutes.

You can manage repositories later from the GitHub icon in the header, or reconnect integrations under Settings → Integrations.

Open Chat and shape an idea into a brief — product and tech specs (and optional mockups) grounded in your codebase. Export to Jira or Linear later when you want a tracker issue.

1. 1Open Chat from the header (or pick Chat with code after indexing).
2. 2Describe what you want to build in plain English, or pick a starter such as Explore an auth flow, Explore a dashboard, or Explore an API.
3. 3Continue until QEEK generates specs. Switch to Architect when specs are ready to refine them in the workbench.
4. 4Find the session under Library → My briefs. Optionally Send to Jira or Send to Linear for a tracker ticket.

Tip: be specific about the problem, users, and constraints. Chat uses your indexed codebase as context, so the clearer the ask, the more actionable the specs.

After the first successful sync, QEEK automatically starts Architecture Overview and Application Flows for your project. You can also generate more documentation on demand.

1. 1Open Health from the header, then Architecture Overview or Application Flows. If a doc is missing, click Generate Architecture Overview or Generate Application Flows.
2. 2Under Repository docs in Health, open a repo section (for example Project Overview, Tech Stack, or Directory Structure) and click Generate when empty.
3. 3Wait for generation to finish, then use the table of contents to navigate the guide.

Regenerate docs when your architecture changes significantly so Architecture Overview and flows stay accurate.

Once a project is synced, the main header unlocks these areas:

• Health — Code Health hub — issues, merge reviews, architecture, dependency graph, flows, and repository docs.
• Chat — Conversational workspace to explore the codebase and shape ideas into specs and mockups.
• Library — Your briefs, chats, and shared sessions.
• Repositories — Add or manage connected repos (GitHub icon in the header).
• Settings — Integrations, members, billing, usage & credits, API tokens, and security.

Until indexing finishes, navigation shows Finish syncing to unlock. Create a project first if you have none yet.