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 or 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 and 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 steps: connect GitHub, create a project, then index.

1. 1Click Connect GitHub. 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 land on the welcome and indexing screen.
4. 4Click Start indexing (or Index all). Indexing usually finishes in under 10 minutes.

Your code stays private. Access is read-only, your source is never stored, and your codebase is never used to train models. You can revoke access anytime from GitHub settings.

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

Open Chat and shape an idea into a technical spec, grounded in your codebase, with optional mockups. Export to Jira or Linear 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 like Explore an auth flow, Explore a dashboard, or Explore an API.
3. 3Keep going until QEEK generates the spec. Switch to Architect when it's ready to refine in the workbench.
4. 4Find the session under Library, then My technical specs. Send to Jira or Send to Linear for a tracker ticket.

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

After the first successful sync, QEEK automatically starts an 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 (like Project Overview, Tech Stack, or Directory Structure) and click Generate when it's empty.
3. 3Wait for generation to finish, then use the table of contents to navigate the guide.

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

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

• Health: the Code Health hub. Issues, merge reviews, architecture, dependency graph, flows, and repository docs.
• Chat: a conversational workspace to explore the codebase and shape ideas into specs and mockups.
• Library: your technical specs, chats, and shared sessions.
• Repositories: add or manage connected repos (the GitHub icon in the header).
• Settings: integrations, members, billing, usage and credits, API tokens, and security.

Until indexing finishes, navigation shows Finish syncing to unlock. Create a project first if you don't have one yet.