Code collaboratively with annotations using Catseye

Keep track of and share information with your teammates, all while staying in the code and not cluttering your code with extra comments.

Features

With annotations, you can...

Keep Track of Code-Related Information

Keep track of your questions, bugs, and tasks by annotating the code you care about.

Navigate Your Code Easily

Catseye's annotation code anchors can be used as bookmarks for the parts of your code you want to go to.

Collaborate

Keep your conversations in the code with annotations -- ask questions, reply with answers, document issues, all while staying in the context of the code.

Manage Your Information

Catseye provides a suite of features to make finding and managing your annotations easy -- merge, filter, search and sort so you can find the information that's important to you.

Getting Started


Installation


Setting Catseye Up

  • Once installed, the extension should prompt you to authenticate with GitHub - you should see a pop-up that says "The extension Catseye wants to sign-in using GitHub" - click "Allow".
    Screenshot showing VS Code GitHub authentication pop-up.
  • Your default internet browser should open to a GitHub webpage that displays a pop-up prompting you to re-open Visual Studio Code. Click "Open Visual Studio Code".
    Screenshot showing GitHub authentication pop-up in browser.
  • Visual Studio Code will now display a pop-up asking you to open "vscode.github-authentication" - click "Open". This will sign you in to your GitHub account in Visual Studio Code and authenticate Catseye with your GitHub account. This will complete the authentication process, and you should now be able to use Catseye!
    Screenshot showing GitHub Authentication pop-up in VS Code.
  • Your browser should open to take you to the Adamite website, where you will be redirected and prompted to authenticate with GitHub in order to create an Adamite account.
  • Once your account has been created, you can go back to Visual Studio Code and try out Catseye!

Congratulations, you now have Catseye installed! Learn how to make your first Catseye annotation .

Also, please join our Slack!