CodeIt Docs - Rubikon Labs Pvt Ltd

Version 1.0.0 – Rubikon Labs

CodeIt is an AI-powered code assistant extension for Visual Studio Code that enhances your coding productivity. It allows you to chat directly with an AI assistant within your IDE, eliminating the need to copy code to external platforms.

Security and Privacy CodeIt prioritizes the security and privacy of your code. All code interactions and data are processed and stored locally on your computer. Your code is never transmitted to or stored on external servers. This ensures that developers can use CodeIt with confidence, knowing their proprietary code and sensitive information remain secure within their local environment.

Key Features

In-IDE AI chat assistant
Smart autocomplete suggestions for code
Code analysis and improvement recommendations
Debugging assistance, including terminal error resolution
Coding standard maintenance
Idea generation for your projects
Support for multiple programming languages
Index external documentation using URLs
Automated comment generation
Assistance in writing unit tests
Legacy code explanation
Choice of multiple LLM (Language Model) options
Usage monitoring dashboard
Local processing and storage for enhanced security
Build custom agents
Rich set of context providers

Installation

Search and Install CodeIt from VS Code extension marketplace
Login using your personal ID
Start using the CodeIt directly into VS Code

Using CodeIt

Chatting with the AI Assistant

Simply type your questions or requests in the CodeIt chat panel. The AI will respond with suggestions, explanations, or code snippets as needed.

Providing Code Context

Use the following commands to give context to the AI:

@filename: Select code files to provide as context. For example, @main.py will include the contents of main.py in your conversation.
@terminal: Add the current terminal output to the chat. This is particularly useful for resolving errors that appear in your terminal.

Quick Code Selection

Use Ctrl + L to add your currently selected code directly to the chat.

Smart Autocomplete

As you type, CodeIt will offer intelligent code completion suggestions based on the context of your project and common coding patterns.

Debugging Assistance

When you encounter errors, CodeIt can help analyze the problem and suggest potential fixes.

Use the @terminal command to share error messages directly from your terminal for more accurate assistance.

Inline Editing

Inline editing allows you to make quick changes directly within your current file.

Highlight a block of code and press Ctrl + I to initiate the edit input.
Describe the changes you want, and the AI will stream the updated code inline.

You can accept or reject the suggested changes instantly.

Comment Generation

To generate meaningful comments for your code:

Select the code you want to comment.
Use the /comment command in the CodeIt chat panel.
CodeIt will analyze your code and generate appropriate comments.
Review the generated comments and make any necessary adjustments.

Unit Test Writing

To get help crafting effective unit tests:

1. Select the code you want to create unit tests for.
2. In the CodeIt chat panel, prompt CodeIt to generate the unit test with the desired framework. For example:

Generate unit tests using pytest for this code:

CodeIt will analyze your code and generate unit tests.
Review the generated tests, adjust as needed, and integrate them into your test suite.

Legacy Code Explanation

If you’re working with unfamiliar or legacy code, CodeIt can provide explanations to help you understand the code’s purpose and functionality.

Choosing LLM Options

CodeIt offers multiple Language Model options. In this initial release (Version 1.0.0), we are supporting OpenAI’s language models, including GPT-3.5 and GPT-4. Support for additional LLMs from other providers is planned for upcoming releases.

Usage Monitoring

Access the usage monitoring dashboard to track your interaction with CodeIt and optimize your use of the extension.

Telemetry

CodeIt uses telemetry to collect anonymous usage data, helping us improve our product and enhance user experience. This information allows us to better understand how users interact with CodeIt and optimize its features accordingly.

Data Collection Overview

We use Posthog, an open-source analytics platform, to gather and store usage data.
All collected data is anonymized and stripped of personally identifiable information (PII) before transmission to Posthog.
Users can opt out of telemetry collection at any time.

What We Collect

CodeIt tracks the following anonymous usage information:

Suggestion Interactions: We record whether suggestions are accepted or rejected, without capturing the actual code or prompts involved.
Model and Command Usage: We note which AI models and commands are used.
Token Metrics: We count the number of tokens generated during interactions.
System Information: We collect the name of your operating system (OS) and integrated development environment (IDE).
Pageviews: We gather general statistics on feature usage within the extension.

Privacy and Transparency

Our commitment is to maintain the privacy and security of your data.
For more details on our data handling practices, please refer to our official privacy policy.

Opting Out

If you prefer not to share your usage data, you can opt out of telemetry collection at any time.