Quickstart
This guide takes you from sign-in to your first assessment. It takes a few minutes.
Before you start
Section titled “Before you start”- You need an invitation. During the pilot, sign-in is limited to invited GitHub accounts and email addresses.
- You need a GitHub repository you are allowed to connect.
1. Sign in
Section titled “1. Sign in”Go to app.nxtstack.io and choose one of two ways to sign in.
- Log in with GitHub. Use your invited GitHub account.
- Email. Enter your invited email address and select Log In. A sign-in link arrives by email. The link works for 10 minutes and must be opened in the same browser you requested it from.
A session lasts 4 hours. After that, sign in again.
2. Connect GitHub
Section titled “2. Connect GitHub”After sign-in you land on New assessment. On the Source control tab, select Choose repositories on GitHub.
GitHub asks which repositories Nxtstack may read, then brings you back to the app. You stay in control of that list on GitHub, and you can change it later with Add or change repositories.
3. Choose one repository
Section titled “3. Choose one repository”Pick one repository from the list and select Continue with selected repository. Use the search box if the list is long.
If your repositories belong to an organization, select Add or change repositories and pick the organization on GitHub.
The repository read runs in the background. You can leave the page while it runs.
4. Confirm what the app is for
Section titled “4. Confirm what the app is for”Nxtstack asks what the application is meant to do. The answer may be filled in for you from the README, the package description, or the GitHub repository description. Check it and correct it.
You also say roughly how many users the app has today and whether it has launched. Then select Confirm purpose and assess.
5. Read the result
Section titled “5. Read the result”The Assessment summary opens with:
- an overall score out of 100 with a letter band, and the coverage behind it
- the highest impact risks
- findings, each with the file and line it came from
- a breakdown by category
From there, open the Improvement plan for ordered tasks you can export as Markdown and hand to your coding agent.
See Reading your results for what each part means.
Try it without connecting GitHub
Section titled “Try it without connecting GitHub”On the New assessment screen, under Available without GitHub, open the Appointment Desk sample. It is a fictional application with sample source and findings, clearly labeled as fictional, so you can see the whole journey first.