search

Codium-ai / codiumai-jetbrains-release

59 stars 8 forks source link

readme

Qodo Gen

Code, test and review with confidence

Qodo Gen is your AI-powered coding assistant and mentor. Qodo Gen helps you understand your code, test it and review it with your team.

Sign in to start using Qodo Gen.

Supports all programming languages!

GitHub Discord X URL

Table of Contents

  1. What can Qodo Gen do?
  2. Using Qodo Gen Shortcuts
  3. Qodo Gen Chat
  4. Code Completion
  5. Tests Generation
  6. Learn More
  7. Support and Community
  8. Data Sharing

What can Qodo Gen do?

Qodo Gen uses advanced AI models to deeply understand your code structure, logic, and context to help you write better code.

With Qodo Gen, you can:

And much more.

Start using Qodo Gen by clicking the Qodo Gen logo in your Extensions bar.

Qodo Gen Demo

Using Qodo Gen Shortcuts

Use Qodo Gen's keybinding shortcuts:

Qodo Gen Chat

Qodo Gen Chat offers real-time coding assistance within your development environment. Use Qodo Gen Chat for:

Focus

Focus is the part of your code that your conversation in Qodo Gen Chat centers around.
It could be an entire file or just a few lines of code.

Choosing Focus

Guidelines on choosing Focus

Select the focus that best fits your current coding task or question. Consider the scope of your query and what it relates to.

Choose the best Context

To get the best, most relevant results to your Chat query, make sure to choose the most relevant Context. This will help Qodo Gen Chat's AI models tailor the best response for you.
Learn more about Context in this document and in our documentation portal.

Switch Focus as needed

You can switch the focus at any time based on the evolving needs of your development work. Qodo Gen seamlessly adapts to the selected focus and updates the context it's using.

Focus types

To choose Focus, click Add focus on the bottom left, or type @ in the chatbox.
You can then select one of two Focus types:

  1. Current File: Focuses on the current file you're working on.

    When choosing Current File Focus, you have to choose a Secondary Focus option. The Secondary Focus refines the context for Qodo Gen Chat's responses.

    There are two options for Secondary Focus:

    • Selected Lines: Manually select lines in your code to set as the focus for your request.

      Selected Lines Focus

    • Component: Select specific code components from the bottom right part of the chatbox. The components consist of functions, methods and classes automatically detected from the current file.

  2. Git Diff: Include Git changes across your entire project, enabling you to manage and review code changes effectively.

    To choose Git Diff click on @ and select Git Diff.
    You can then choose to focus on either Local Changes, Staged Changes or Committed Changes.

    Git-Diff supports commands for managing commits, documentation, code quality, and more.

Context

Think of Context like the brain of Qodo Gen Chat. The Context is what Qodo Gen's AI models know about your code and what they use to give the best, most accurate response.

Adding more context will give more accurate and relevant responses, so choosing context is an important part of using Qodo Gen Chat to your advantage.

Adding Context

There are multiple ways to add Context to Qodo Gen Chat:

  1. Code Snippet: Select a few lines of code from your project to add as context.

    Usage: Select a code snippet, right-click and choose Add to Qodo Gen as context.

    Snippet As Context

    Shortcuts:

    • VSCode:

      • Mac: Cmd+Shift+E
      • Windows: Ctrl+Shift+E

    • JetBrains:

      • Mac: Cmd+Option+Comma
      • Windows: Ctrl+Alt+Comma

  2. Files: Select any file from your project to add as context.

    Usage: Click on @ or type @ in the chatbox, and select Add a file or a folder.
    Alternatively, right-click any file from your project and choose Add to Qodo Gen as context.

  3. Folder: Select any folder from your project to add as context.

    Usage: Click on @ or type @ in the chatbox, and select Add a file or a folder.
    Alternatively, right-click any folder from your project and choose Add to Qodo Gen as context.

  4. Entire Project: Select your entire project to add as context.

    Usage: Click on @ or type @ in the chatbox, and select Add a file or a folder. Under the searchbar, choose Full project.

  5. Image: Select any image to add as context.
    For example, add an image of a required design and Qodo Gen Chat will help you create it.

    Usage: Click on @ or type @ in the chatbox, and select Upload an image.

    Learn more about adding images to the chat.

Commands

Commands are what Qodo Gen Chat is all about. Call a command to unlock all of Qodo Gen Chat's capabilities.

To call commands either:

Calling Commands

Commands List

Find out more about Qodo Gen Chat Commands on our documentation portal.

Chat History

Qodo Gen maintains a history of your 20 most recent conversations, allowing you to review past interactions, refresh your memory, or explore new topics.

You can continue a past chat to dive deeper into a topic or request additional information.

Currently, your chat history wouldn't be saved between sessions, and will be deleted once you close IDE. We are working on adding this feature in the future. Stay tuned!

To get to your Chat History, click on the History button on the top right, next to the "New Chat" button.

Learn More

You can find out more about Qodo Gen Chat in our documentation portal.

Code Completion

Qodo Gen Code Completion is a powerful tool designed to accelerate your coding process, reducing the need for repetitive tasks such as copying and pasting code snippets from the internet.
By enabling Code Completion, Qodo Gen learns from your codebase and provides real-time suggestions that seamlessly integrate with your writing flow.

Code Completion

Use Code Completion

Code Completion is a Pro feature, exclusively available for Teams and Enterprise users. Visit Qodo's website to learn more.

As you type, Qodo Gen analyzes your code in real-time to grasp your intention. It then presents code completions in a grayed-out format directly in your editor. These suggestions aim to complete your current line of code or offer snippets that fit the context of your work. To accept a suggestion, simply press the Tab key, and the completion will be inserted into your code.

Customization

Configure Qodo Gen Extension settings to customize Code Completion to suit your specific coding style and needs.

Provide general instructions to guide Qodo Gen in generating code completions. This customization ensures that the suggestions are not only accurate but also align with your preferences and project requirements.

Learn how to configure your Code Completion settings.

Learn More

You can find out more about Code Completion in our documentation portal.

Tests Generation

Qodo Gen leverages advanced AI technology to generate comprehensive tests for any programming language.

Test generation boosts productivity, enhances code quality and simplifies the development process, helping you deliver reliable, high-performance software with ease.

TestGeneration

Using Test Generation

The Qodo Gen Testing tab will open.

Test Suite

Improve Tests

The more context, the better the tests generated by Qodo Gen.
Provide test examples to Qodo Gen in the test box and improve your generated tests.

Explore Behavior Coverage

The Behaviors Coverage section categorizes function behaviors into three main types, each representing a different aspect of how your code operates:

Click on Generate test next to any behavior to generate a test for a specific behavior type.

Tests

In this section you can find tests generated by Qodo Gen and run them.
Alternatively, you can Run and auto-fix: if a test fails, Qodo Gen will attempt to fix it automatically and re-run it.

Context

Qodo Gen uses your codebase as Context to generate the most relevant tests. You can manage this Context in the Context tab.

Configuration

You can improve and personalize your test suite in the Configuration section.

Learn More

Find out more about test generation in our documentation portal.

Uninstall Qodo Gen

  1. Click on the Qodo button in the bottom status bar.
  2. Hover over the authentication notification, select the settings icon and choose the Manage Extension option.
  3. Qodo Gen Extension will open in a new tab. Select Uninstall and reload VSCode.

Learn More

Find out more about Qodo Gen and other Qodo products in our documentation portal.

Support and Community

Need help? Visit our FAQ and troubleshooting guide.

Join our Discord community!

Data Sharing

Similar to other popular generative-AI tools, we transmit code snippets to our servers. You can learn more in our terms of use and privacy policy.

You can opt out of sharing data with Qodo.
Go to the extension's settings and check the box Opt out of sharing my data with Qodo.