Important Note: As of now Spectral only works for Javascript / TypeScript codebases. More programming languages will be supported in the future!

Pre-requisite

Having Node and npm installed

We're excited to have you onboard with Spectral!

With Spectral, you can easily navigate your codebase, visualizing the connections between functions and variables on an infinite canvas, similar to a map.

Future features include real-time code editing, debugging on the Spectral canvas, adding annotations, and a multiplayer collaboration mode.

As Spectral is still in its early stages, there are many bugs to address and we are all ears for feature requests! If you encounter any issues or want to submit feature requests, please help us by creating a GitHub Issue at Spectral-community, or contact us at fron@spectral.wiki. Feel free to include detailed descriptions and visuals such as screenshots or screen recordings of the bugs.

Running Spectral

To use Spectral, follow these steps:

1. Open any JavaScript (JS) / TypeScript (TS) file and place your cursor at any arbitrary function name (or if its anonymous function, place the cursor at the function signature)
2. Right click on that function and pick Trace with Spectral (or Press CTRL + SHIFT + S) to start navigating your code in Spectral, beginning at that arbitrary function

Note: If you are using a mouse, hold the right-click button and drag the cursor to pan the canvas around

Spectral Features