Documatic

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!

Features

• Codesearch
  • Search your codebases using natural questions
• Code analysis
  • Code owner
  • Code descriptions (only available for users on a team plan)
  • More coming soon
• Team collaboration
  • Code comments
  • Code groupings/labels

See requirements for using the extension and a guide on how to use the extension below. Want more features? Open a feature request! See below for more information.

Requirements

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, please contact shane@documatic.com to arrange a call.

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, please contact shane@documatic.com for help. N.b. You currently cannot create Documatic projects via the VSCode extension; this has to be done via the Documatic platform.

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.

Codesearch

To run a search:

• Run the command "Documatic Search" or use the shortcut cmd + K.
• Type in your search in query into the text field and press enter
• Select which project to run your search over (defaults to all projects)
  • The extension shows which projects, if any, are in your active VSCode workspace
• The extension will display the top code snippets in a list
• Click on "view" to be navigated to a code snippet
  • If the project is in your active VSCode workspace, your will be navigated to the code file
  • If the project is not in your workspace, a copy of the code file will be created and opened

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, please contact shane@documatic.com.

Team insights

The Documatic extension provides a number of code and team insights for each indexed snippet, including:

• Code complexity
• Code summary/description
• Team comments
• Code grouping/label
• Code owner

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 reload/refresh icon at the top of the Documatic panel, or alternatively by running the command:

1. ctrl+shift+p to bring up the command panel
2. Enter the Documatic: Refresh command

Signing out

If you need to sign out of your Documatic account on VSCode, press the Sign out button at the bottom of the Documatic panel, or alternatively by running the command:

1. ctrl+shift+p to bring up the command panel
2. Enter the Documatic: Clear command

Issues and updates

Known Issues

• Your signed in session can time out on the extension without the UI updating
  • As a temporary work around, clearing your VSCode session can reset this
• On some VSCode versions, an error occurs when running a search
  • Please update your VSCode and restart your system

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.

Security

If you believe you have found a security vulnerability, please do not post details on public channels. Instead, please contact security@documatic.com or shane@documatic.com with details of the vulnerability. For more information, please see SECURITY.md.

Changelog

For full release notes, please see the complete changelog in the repository.

About Documatic

Documatic is building tools to help you better understand your code.
Don't ask your boss, ask Documatic.