This extension brings Documatic to VSCode: quickly search your large codebases using simple queries - what does it do? what dependencies does it have? And more.
Documatic search uses AI to link relations between your query and snippets of code, so you don't have to know the exact keywords you're looking for!
IMPORTANT: To use this extension,
you must have an active Documatic account.
Sign up for an account here.
If you're on the waitlist
and would like to get your team onboarded,
On your Documatic account,
you must have indexed at least 1 codebase.
If you've very recently indexed a new codebase,
it takes a short while
for the codebase to become searchable;
if you're not getting results,
wait a few minutes.
If this persists,
Using the extension
Connecting your account
On the Documatic tab in VSCode, click "sign in". This will take you to the Documatic web platform, where you can sign in. Once you've signed in, you will see your Documatic organisations and projects. If you have not already created a Documatic account, you will be prompted to do so at that point; once your account is created, you may have to restart the VSCode "sign in" process in order to active your VSCode extension.
N.b. You currently cannot manage organisations and projects from the extension. Please log in to the Documatic web application to make changes.
To run a search:
N.b. The version of the codebase indexed for search
is the main/master branch at time of indexing.
Documatic does not index a live version of your codebase.
The extension still works on other branches,
however changing branches or making updates to the code
may result in discrepencies between line numbers
when navigating to the code.
Documatic reindexes your codebases regularly.
If you would like non-main branches to be indexed
for your team,
The Documatic extension provides a number of code and team insights for each indexed snippet, including:
N.b. some of these are only available on a team plan.
To see the information for a code snippet, hover over the code snippet in the editor.
Commenting on code
With the Documatic extension, you can add comments directly to your code which are shared across your team.
To make a comment, in the editor, click on the comment symbol next to a code snippet which was indexed by Documatic. If there is not comment symbol, that snippet was not indexed by Documatic; contact Documatic to promote to a team plan and get your full codebases indexed.
Refreshing your account
If you logged into Documatic on the VSCode app
and subsequently added more projects/organisations,
you will need to fresh your connection.
You can do this by pressing the
If you need to sign out of your Documatic account
Issues and updates
Bugs and features
If you have found a bug you would like to report or if there is a feature you would added, please open an issue on the public issue tracker.
If you believe you have found a security vulnerability,
please do not post details on public channels.
For full release notes, please see the complete changelog in the repository.
building tools to help you better understand your code.