Help / Guides
Register design docs and source code as AI references
When you register references, the AI can search and read the target service's source code and documents when it creates or fixes tests. Only the locations you register are used.
Add a reference
Open Settings → References and choose a type from + Add….
| Type | How it is read |
|---|---|
| Local folder | Reads a folder on this PC |
| Git repository | Shallow clones and reads from GitHub, GitLab, or an internal Git server |
| Notion | After connecting, fetches and reads the specified pages |
| Google Drive | After connecting, fetches and reads the specified folders and files |
| Other web page | Registers a link to open in the browser. The page body is not loaded as a reference |
If the project is inside the target service's Git repository, that repository is added as a reference automatically.
Connect Notion and Google Drive first in Settings → Connections. For private GitHub / GitLab repositories, the SSH keys and Git credentials on this PC can be used. Notion, Google Drive, and Git tokens are stored in the OS keychain, not in project files.
What is read
- For local folders, the contents of the specified folder are read.
.git,node_modules, and files starting with.envare not read. - Git, Notion, and Google Drive references can be searched and read after they are fetched. Web page references are links only.
- To have the AI read a public web page just once, attach the URL in the chat and choose Load as Material. For attaching URLs, see Create and fix tests with AI.
In the CLI, you can check references with gnosis-echo ref list, ref search, and ref show. → Use from the CLI and LLMs