Onboarding, screen by screen
Guide
This is the code-index setup, one screen at a time: an account, its workspace, GitHub, one indexed repository, a search, an agent key, and the first finding an agent proposes. The screens come from a new account, Ada Lovelace. Getting started says the same in fewer words. For the desktop app, follow muxcode’s first run first. You do not need to index a repository before starting a task on your own checkout.
Hobby keeps the repository you choose but indexes nothing and has no code search, so the index, search and context steps need Pro, Pro+ or the trial.
The screenshots show the code-index flow. Your plan, account name and available sign-in providers may differ.
- 1 Sign up account
- 2 Workspace Personal
- 5–7 Connect GitHub grant repos
- 8 Choose repositories and a branch
- 9 Index Copying, Current
- 10 Search from Home
- 11–12 Access key for your agent
- 13 Findings an owner approves
- 14 Trace how context was used
in mux on GitHub for your agent
1. Create your account
Section titled “1. Create your account”Open Create your account. Use an enabled social sign-in button, or enter a name, email and password. Accept the terms and conditions, complete the Cloudflare human check when shown, then press Sign up. A disabled provider is not available on that deployment.
After an email sign-up, Verify your email asks you to open the link mux sent. The link brings you to Log in to mux: log in with the same email and password. Resend verification email sends a new link, and Forgot password? on the login page starts a password reset. If the address already has a mux account, the email says so and links to the login page instead; mux makes no second account.
If the page asks you to complete the human check but no check appears, reload it in a regular browser and let the check finish. Repeated submissions do not prove that your password was wrong.
What you will seeCreate your account; after an email sign-up, Verify your email, then Log in to mux.
2. Start in your Personal workspace
Section titled “2. Start in your Personal workspace”A workspace holds your team’s repositories and their one search index. Every new account starts with one, named Personal: after you sign up, mux opens it and you land on Home. Rename it whenever you like: open the account menu at the foot of the sidebar, choose Settings, and change Name under Workspace. Hobby includes this one workspace. Pro and the trial add one team workspace, and Pro+ twenty-five.
If someone invited you before you signed up, mux makes no Personal workspace yet: accept the invitation and open their workspace from the Workspaces page. If you decline it, you get your Personal workspace the next time you open the app. Workspaces lists every workspace you can open, and has Website and Sign out at the top, in case you signed in with the wrong account.
What you will seeHome, with Personal as the active workspace in the top bar.
3. Home, before anything is indexed
Section titled “3. Home, before anything is indexed”Home is where you search. Until a repository is chosen it says so and sends you to Choose repositories. While its first index is built, Home lists your repositories and how their index stands. Once one can be searched, Home shows what your coworkers did while you were away and the month’s activity. The sidebar holds Home, Code Index, Cowork and Sessions; then Overview and Access keys under Workspace; then Members, Usage and Billing under Subscription. The active workspace’s name is in the top bar: press it to switch, or to reach Manage workspaces…. Your name and plan are at the foot of the sidebar; that menu holds Settings, Help, Website and Sign out.

4. Overview lists what is left
Section titled “4. Overview lists what is left”Overview, under Workspace in the sidebar, lists what is left under Set up search, each step marked done, next, or waiting. The next one is Choose repositories, with a Connect GitHub button. Once every step is done the list goes, and the page shows what is searchable.
What you will seeChoose repositories marked next, with Connect GitHub.
5. Connect GitHub
Section titled “5. Connect GitHub”Open Code Index and press Connect GitHub. mux reads only the repositories you grant, and never writes to them. The same page lists the nine tools an agent reaches over MCP.
If the mux app is already installed on that GitHub account, for example after a connection that expired, press Link an existing installation instead. GitHub asks you to authorize the app, then sends you back to mux at step 8.
What you will seeCode Index with GitHub not connected, Connect GitHub, and the nine MCP tools.
6. Choose where to install the app
Section titled “6. Choose where to install the app”GitHub asks which account or organization gets the mux app. Choose the one that owns the code. An account where the app is already installed says Configure instead, and that page does not send you back to mux. Return to Code Index and press Link an existing installation.
What you will seeGitHub’s page that asks where to install the mux app, listing your account and your organizations.
7. Grant only the repositories you want
Section titled “7. Grant only the repositories you want”Choose Only select repositories and pick the repository. The app asks for
read access to code and metadata. Confirm that you are authorizing the
production app and that the return URL begins with https://usemux.com/.
Do not approve a staging application. Press Install & Authorize; GitHub
sends you back to mux.
What you will seeGitHub’s install page with Only select repositories and read access to code and metadata.
8. Choose the repository to index
Section titled “8. Choose the repository to index”Back in mux, tick the repository, keep the default branch or pick another from the list, and press Save repositories. The button stays off until you change something. Hobby saves one repository and indexes it once the workspace has a paid plan or a trial; Pro and the trial index twenty, and Pro+ fifty. A team workspace indexes as many as the best plan among its members.
What you will seeYour repository ticked, its branch, and Save repositories.
9. Watch the first index build
Section titled “9. Watch the first index build”The repository is copied, then its files are cut along their syntax. The row says Copying, then Indexing, while it works, and Queued while another index run goes first.
When it is done the row says Current, with the file and passage counts and the commit it read. A row says Behind once its branch has newer commits. Pro, Pro+ and the trial refresh on every push. On Hobby the row says Chosen: the repository is kept, and indexed once the workspace has a paid plan or a trial. A team workspace refreshes on push while at least one member is on Pro, Pro+ or a trial, and indexes nothing otherwise. If GitHub turns a read away for a moment, mux tries again by itself.
Behind goes back to Indexing: Pro, Pro+, trial: every push Hobby: indexes nothing
10. Search from Home
Section titled “10. Search from Home”Type a name from the code, or ask in your own words. Hobby has no code search: in its place Home says search comes with Pro and Pro+, with See plans. The menu beside the box narrows the search to one repository. Every passage names the repository, the file and the line, and links to the commit it was read from.
What you will seePassages under the box, each with its repository, file and line, and a link to the commit.
11. Create a key for your agent
Section titled “11. Create a key for your agent”Open Access keys, under Workspace in the sidebar. Under API keys, press New key if the workspace already has a key; with none, the form is already open. Keep Key for and Role as Agent, name the key after the tool that will use it, and pick an expiry date if you want one: the key stops working at the end of that day. Press Create key. Copy the key at once with Copy: mux shows it only this one time. It is hidden here. The key joins the list below, with Revoke.

12. Connect your agent
Section titled “12. Connect your agent”Give the key to your agent as a Bearer token for https://usemux.com/mcp.
For Claude Code, put the variable, not the key, in .mcp.json:
{ "mcpServers": { "mux": { "type": "http", "url": "https://usemux.com/mcp", "headers": { "Authorization": "Bearer ${MUX_API_KEY}" } } }}The MCP guide covers Codex, Claude Code and GitHub Copilot CLI. muxcode signs in from its own window instead, under Settings → Workspace → Overview → Connect to mux; no key is copied by hand.
An agent starts a task with get_context: one packet of evidence tied to the
indexed commit, with the files the code graph links to it, and relevant notes
from memory. With workspace_memory it keeps memory across sessions, on Pro, Pro+
and the trial: shared notes for the whole workspace, and private notes for
you alone. Hobby has no memory. When it learns something the whole
workspace should trust, it proposes a finding with record_context_outcome,
naming the files the finding rests on.
13. Review what your agent proposes
Section titled “13. Review what your agent proposes”A proposed finding waits under Findings on the Overview page for an owner. Nothing reaches another agent until you press Approve. An approved finding comes back with each packet that reads its commit, and moves to each new commit while the files it cites stay the same. Retire takes it out.
What you will seeThe proposed finding under Findings, with Approve and Retire.
14. See how context was used
Section titled “14. See how context was used”Context trace, on the same page and for owners only, lists each packet: when, which key asked, how many passages, how long it took, which commits it read, the approved findings it carried, and what became of the findings proposed from it. The line on top covers the last seven days: how many packets, how fast, and how many read a commit behind the branch.
What you will seeContext trace: the seven-day line on top, then one row per packet.
What your plan changes
Section titled “What your plan changes”The plans change these figures on the same path. What each plan includes has the rest: prices, sandboxes, Clef and API limits.
| Hobby | Pro | Pro+ | Pro trial | |
|---|---|---|---|---|
| Team workspaces besides your own | 0 | 1 | 25 | 1 |
| Repositories indexed | none (1 chosen) | 20 | 50 | 20 |
| Index refresh | none | on every push | on every push | on every push |
| Search from Home | none | names, and your own words | names, and your own words | names, and your own words |
| Agent memory | none | yes, by meaning | yes, by meaning | yes, by meaning |
| Index hours a month, per workspace | none | 30 | 30 | 30 |
| Search and memory hours a month, across your workspaces and teams | none | 50 | 300 | 50 |
A team workspace indexes as many repositories as the best plan among its members, and refreshes on push while at least one member is on Pro, Pro+ or a trial. An owner’s plan counts for as many of their team workspaces as it includes, the ones picked on Billing first, then the oldest.
When a plan ends or moves down, a workspace keeps the repositories you added first, up to the new plan’s figure. Code Index names the rest and the day mux removes them, a week on.
- Getting started: pattern search, search by meaning, and plan limits.
- muxcode: advanced guide: get the most out of the desktop app.
- MCP guide: every tool and its arguments.
- API reference: the same operations over HTTP.