Documentation v1.1.0

[pranshugupta54]

Traycer: AI-Powered Code Analysis in Real Time

Basic_Usage.mp4

What's Traycer?

Traycer is an advanced code analysis tool for Visual Studio Code, enhancing software quality and developer productivity with live, context-aware insights. Acting like a vigilant senior developer, it analyzes changes in real-time, identifying issues and offering corrections without disrupting your workflow. Traycer ensures comprehensive coverage by examining changes and their implications on related code, addressing potential bugs, and enhancing application robustness. It provides clear, actionable suggestions that can be integrated into your code with a single click.

Table of Content

• Important Links
• Features
  • Triggering Analysis
    • Switching Between Manual and Automated Analysis
    • Manually Triggered Analysis
    • Checking Analysis Status
  • Comments & Replies
    • (A) Navigator
    • (B) Traycer Comment
  • Analysis History
• Preferences
  • Modifying Settings
    • Via Extension Settings Page
    • Via Command Palette
    • Via Side Panel Preferences
  • Execution Mode
  • Comment Indicator
  • Comments Highlighting
  • Output Level
• Supported Languages
• Feedback Forum
• Terms of Service and Privacy Policy

Important Links

• Free 14-day trial: Get started with Traycer by signing up for a free 14-day trial. No credit card required.
• Plans & Pricing: Explore our subscription plans and pricing options to choose the best fit for your needs.
• FAQs: Find answers to common questions about Traycer, its features, and usage.

Features

Triggering Analysis: Manual vs. Automated

Traycer provides flexibility in how you trigger code analysis:

1. Automatic Analysis (default)
   Traycer continuously tracks your activities and performs analysis in real-time. Analysis is triggered automatically by events such as saving your work.
2. Manually Triggered Analysis
   This allows users to initiate the analysis at their convenience through various methods, providing flexibility and control.
   • Analyze File: This option comprehensively reviews the entire file, regardless of recent changes. It checks the code for consistency, errors, and adherence to coding standards.
   • Re-Analyze File: This option behaves similarly to Analyze File but is useful for re-evaluating the entire file without evaluating what has already been analyzed in a previous analysis.
   • Analyze Changes: This option focuses solely on recently modified functions. It's ideal for quickly verifying modifications without analyzing unchanged parts of the file.

Switching Between Manual and Automated Analysis

Configure your preferences to switch between manual and automated analysis modes.

Different ways to switch between Manual and Automated Analysis

1. Using Command Palette: -

   • Open the Command Palette in VS Code (Ctrl+Shift+P OR Cmd+Shift+P on Mac).
   • Type and select Traycer: Enable Auto Analysis OR Traycer: Disable Auto Analysis.

2. Extension Settings Page:

   • Go to the Traycer extension settings page in VS Code.

   • Change the "Traycer: Execution Mode" setting to "Manual" or "Auto".
     
     
     

     execution-mode-settings.mp4

Manually Triggered Analysis

This allows users to have full control over when the analysis runs. Users can trigger the analysis process manually, making it useful for reviewing and refining code at specific points in the development workflow.

Different ways to trigger Analysis manually

1. Editor Toolbar: Click the Traycer icon on the top editor toolbar to trigger analysis on the current file.

   

2. Right-click Menu: Right-click anywhere in the code file and select Traycer > Analyze File, Re-Analyze File, or Analyze Changes.

3. Command Palette: Run Traycer: Analyze File, Traycer: Re-Analyze File, or Traycer: Analyze Changes from the command palette by using Ctrl + Shift + P or Cmd + Shift + P.

Note: Only available for supported languages.

Checking Analysis Status

To check the status of your analysis, hover over the Traycer icon. It will display the count of running analyses, such as "Traycer in-flight analysis: X". If the count is 0, it means there are no analyses currently running.

analysis-status.mp4

Comments & Replies

Traycer adds comments to your code, suggesting improvements and highlighting potential issues such as bugs, performance, security, and clarity. These comments provide actionable insights to help you refine your code, maintain high standards, and address problems early in the development process. Additionally, you can reply to comments to engage in a conversation with Traycer, allowing you to discuss and resolve issues directly within the context of each comment.

(A) Navigator

To navigate and manage comments in Traycer, follow these steps:

1. Open the side panel by clicking on the Traycer icon in the activity bar.
2. Browse through the list of comments categorized by labels such as bugs, performance, security, and clarity.
3. Use the Wand icon (🪄) next to a comment to directly apply the suggested fix, if the icon is present. Some comments may not have a suggestion.
4. Use the search box to find comments by text, filename, or file path.

(B) Traycer Comment

The Comment Detailed View in Traycer provides an in-depth look at each comment, offering context and actionable insights to help improve your code. Here are some key features:

1. Code Snippet Display with Diff: The comment includes a relevant code snippet showing the differences between your current code and the suggested changes from Traycer AI. This helps you understand the exact context of the comment and the proposed improvements.

2. Reply and Discuss: You can engage in a conversation with Traycer by replying to comments. This allows you to discuss the issues directly within the context of each comment, making it easier to resolve problems and refine your code.

3. Quick Fix: The Wand icon allows you to directly apply the suggested fix, streamlining the process of addressing issues. If a comment does not have a suggested fix, the Wand icon will not be present.

4. Comment Deletion: The Bin icon allows you to delete the entire comment along with its conversation.

5. Feedback Options: You can give a thumbs up or thumbs down to provide feedback on the comment. This helps improve the accuracy and usefulness of future comments.

6. Actionable Insights: Each comment suggests improvements or highlights potential issues such as bugs, performance, security, and clarity. The detailed view provides a clear explanation of the issue and how to address it.

Analysis History

Keeps a record of all past analyses performed, allowing you to review and track changes over time. Each entry includes key details such as the trigger type, state of completion, duration, and statistical breakdowns of the analysis. You can monitor the number of successfully analyzed code blocks, failed analyses, skipped sections, and other relevant metrics, helping you understand the effectiveness and progress of your code improvements.

To access the analysis history, follow these steps:

1. Open the Traycer side panel by clicking on the icon in the activity bar.
2. Click on the history icon at the top.
3. View the history for each analysis.

Preferences

Customize your Traycer settings to fit your development workflow and preferences.

Modifying Settings

To modify any setting, follow these steps:

Via Extension Settings Page

1. Click on the gear icon in the lower-left corner and select "Settings," or use the shortcut Ctrl + , (Cmd + , on Mac).
2. In the settings search bar, type "Traycer" to filter and find all related settings.
3. Modify any of the Traycer settings as needed.

Via Command Palette

1. Open the command palette by pressing Ctrl + Shift + P (Cmd + Shift + P on Mac).
2. Type "Traycer" to view and select various commands related to Traycer settings.
3. Execute the desired command to modify the settings.

Via Side Panel Preferences

1. Open the Traycer side panel by clicking on the icon in the activity bar.
2. Click on the gear icon at the top.
3. Modify the settings as needed.

Execution Mode

Specifies how Traycer triggers analysis of files.

1. Auto: (Default) Traycer continuously tracks your activities and performs analysis in real-time as you write and modify your code. Analysis is triggered automatically by events such as saving your work.

2. Manual: Users have full control over when the analysis runs. You can trigger the analysis process manually at specific points in your development workflow, either for the entire file or only for recent changes.

Comment Indicator

Specifies how comments are displayed in the editor. You can choose from the following options:

1. CodeLens: Displays comments above the relevant lines of code, providing inline context.
2. Hover Tooltips: Shows comments when you hover over the relevant lines of code.
3. Both (default): Combines CodeLens and hover tooltips, ensuring comments are always visible while also providing additional context on hover.

Comments Highlighting

Specifies how comments are highlighted in the editor. Highlighting is useful for quickly identifying code lines with comments. You can enable or disable highlighting and customize the color to fit your preferences. The default setting is disabled.

Output Level

Specifies how much (if any) output will be sent to the Traycer output channel. You can configure the level of detail for the output, ranging from minimal to detailed logs. The default level is set to "info".

Supported Languages

Currently, Traycer supports the following programming languages:

• Python
• TypeScript
• JavaScript
• Golang
• TypeScript React
• JavaScript React
• Rust
• PHP

Feedback Forum

We value your input and encourage you to share your experiences and suggestions with us. Connect with us and the community in the following ways:

• Discord: Join our community here

• X (Twitter): Follow us @TraycerAI

• GitHub: Encounter a bug or have a feature request? File an issue on our community repository.

Terms of Service and Privacy Policy

By using Traycer, you agree to our Terms of Service and Privacy Policy.