Docs
From your repository to a map you can trust.
These pages walk through the whole product: connecting a repository, reading the map, understanding what a change will touch, and keeping the reasons behind the code. If you would rather be shown than read, tell us and we will walk through it with you.
Start here
Sign in with GitHub, choose the repositories Nykst may read, and the map appears. There is nothing to install in your codebase and nothing to configure first.
- Connect your GitHub account.
- Choose one repository to start with.
- Open the map and pick any file.
Connect a repository
You decide which repositories to connect, one or many. You can remove access at any time from your GitHub settings or by asking us. Your code is never written to.
Private repositories are supported. If your organisation requires an owner to approve access, GitHub will send that request for you.
Read the map
The map has six levels: your whole organization, the areas your system divides into, what each area does, the services and database tables it uses, its modules, and the files inside them.
Click any level to move into it. The path at the top always shows where you are, and the page updates in place, so you can go back without losing your place.
Open the system mapWhat a change will touch
Pick a file and see what imports it directly, what depends on it further away, which pages and endpoints reach it, and which tests cover it. The same view tells you what removing an export, renaming a column, or changing a function signature would break.
Check a file before you edit itKeep the history
Decisions, past incidents and team conventions stay attached to the parts of the system they explain. When someone asks why a file looks the way it does, the reason is next to the file instead of in a chat thread.
Explore system historyUse it in your editor
If you work in an editor or a coding assistant, you can ask the same questions there and get the same answers before the code is written.
Set up your coding assistantDeveloper notesTechnical referenceGuides
Three proofs you can check yourself
Each guide uses the public Nykst example, cites the file and line, and states what the proof does not cover. No account needed.
Your account, your data and help
You can ask for a copy of your data, correct it, or close your account at any time. If something looks wrong, tell us and a person will reply within 2 business days.