The onboarding flow
Everything you need to set up happens in the Scirix onboarding wizard, found at the /onboarding page of the app. The wizard runs top to bottom. Each step unlocks when the one before it is complete.
Before any step becomes available, you must respond to the usage tracking consent card at the top of the page.
The steps🔗
| Step | Title | What you do |
|---|---|---|
| Step 0 | Name your organization | Enter your organization name. Only shown if you do not have one yet. |
| Step 1 | Where do you want to pull code from? | Pick your git source: GitHub, GitLab, Gitea, Bitbucket, Azure DevOps, a self-hosted instance, or a custom clone URL. |
| Step 2 | Connect and pick repositories | Authorize the git source and select repositories, or paste clone URLs. |
| Step 3 | Name your namespace | Confirm the namespace name. A suggestion is derived from your first repository. |
| Steps 4 and 5 | Model setup | Choose which models power the namespace, and which model builds the search index. |
| Step 6 | Learn the namespace | Scirix indexes your code and shows progress: files, chunks, symbols and detected languages. |
Steps 4 and 5 only unlock after your namespace has been created in Step 3.
Where each step is documented🔗
- Steps 0 to 3 are covered in Connecting your code.
- Step 4 depends on the path you choose. Read Managed models, Bring your own API key or Bring your own hardware.
- Step 5 is covered in The embedding index.
- Step 6 is covered in Learning the namespace.