All pages
Powered by GitBook
1 of 4

Loading...

Loading...

Loading...

Loading...

Installation guide

Installing on Visual Studio Code

It takes less than 2 minutes

Get up and running with Bito in just a few steps! Bito seamlessly integrates with Visual Studio Code, providing powerful AI-driven code reviews directly within your editor. Click the button below to quickly install the Bito extension and start optimizing your development workflow with context-aware AI Chat, and more.

Video guide

Watch the video below to learn how to download the Bito extension on VS Code.

Step-by-step instructions

  1. In Visual Studio Code, go to the extension tab and search for Bito.

  1. Install the extension. We recommend you restart the IDE after the installation is complete.

Starting with Bito version 1.3.4, the extension is only supported on VS Code versions 1.72 and higher. Bito does not support VS Code versions below 1.72, and earlier versions of Bito do not function properly on these older versions.

  1. After a successful install, the Bito logo appears in the Visual Studio Code pane.

  1. Click the Bito logo to launch the extension and complete the setup process. You will either need to create a new workspace if you are the first in your company to install Bito or join an existing workspace created by a co-worker. See

Visual Studio Code Marketplace Link

Setup Bito extension in VS Code running through SSH

SSH (Secure Shell) is a network protocol that securely enables remote access, system management, and file transfer between computers over unsecured networks.

Visual Studio Code IDE allows developers to access and collaborate on projects from any connected machine remotely. The corresponding extension [Remote -SSH] must be installed on the host machine's Visual Studio Code IDE to utilize this feature.

The Bito VS Code extension seamlessly integrates with Remote development via SSH, allowing developers to utilize Bito features and capabilities on their remote machines.

Remote SSH connection and setup

Please follow the instructions given in the links below:

Video Guide:

Setup Bito extension in VS Code running through WSL

Running VS Code on WSL allows developers to work in a Linux-like environment directly from Windows. This kind of setup is to take advantage of development experience on both operating systems.

WSL provides access to Linux command-line tools, utilities, and applications, to enhance productivity and streamline the development process.

This setup ensures a consistent development environment across different systems, making it easier to develop, test, and deploy applications that will run on Linux servers.

WSL connection and setup

Please follow the instructions given in the links below:

Video Guide:

Installing on JetBrain IDEs

It takes less than 2 minutes

Get up and running with Bito in just a few steps! Bito seamlessly integrates with popular JetBrains IDEs such as IntelliJ IDEA, PyCharm, and WebStorm, providing powerful AI-driven code reviews directly within your editor. Click the button below to quickly install the Bito extension and start optimizing your development workflow with context-aware AI Chat, and more.

Video guide

Watch the video below to learn how to download the Bito extension on JetBrains IDEs.

Step-by-step instructions

  1. In JetBrains IDEs such as IntelliJ, go to File -> Settings to open the Settings dialog, and click Plugins -> Marketplace tab in the settings dialog. Search for Bito.

2. Click "Install" to install the Bito extension. We recommend you restart the IDE after the installation is complete.

Starting with Bito version 1.3.4, the extension is only supported on JetBrains versions 2021.2.4 and higher. JetBrains version 2021.1.3 is no longer supported from Bito version 1.3.4 onward.

3. Bito panel will appear on the right-hand sidebar. Click it to complete the setup process. You will either need to create a new workspace if you are the first in your company to install Bito or join an existing workspace created by a co-worker. See

The menu to invoke the settings dialog may differ for different IDEs of the JetBrains family. The screenshots highlighted above are for the IntelliJ IDEA. You can access the Bito extension directly from the JetBrains marketplace at .

Install on VS Code

Managing workspace members
https://marketplace.visualstudio.com/items?itemName=Bito.bito
https://code.visualstudio.com/docs/remote/ssh
https://learn.microsoft.com/en-us/windows-server/administration/openssh/openssh_install_firstuse
https://code.visualstudio.com/docs/remote/wsl-tutorial
https://learn.microsoft.com/en-us/windows/wsl/install

Install on JetBrains

Managing workspace members
https://plugins.jetbrains.com/plugin/18289-bito
Settings in IntelliJ IDE
Bito in IntelliJ right-hand side bar

Vim/Neovim Plugin

Vim/ Neovim Plugin for Bito Using Bito CLI

We are excited to announce that one of our users has developed a dedicated Vim and Neovim plugin for Bito, integrating it seamlessly with your favorite code editor. This plugin enhances your coding experience by leveraging the power of Bito's AI capabilities directly within Vim and Neovim.

Installation

To get started with "vim-bitoai," follow these steps:

Step 1: Install Bito CLI

Make sure you have Bito CLI installed on your system. If you haven't installed it, you can find detailed instructions in the Bito CLI repository at https://github.com/gitbito/CLI.

Step 2: Install the Plugin

Open your terminal and navigate to your Vim or Neovim plugin directory. Then, clone the "vim-bitoai" repository using the following command:

Step 3: Configure the Plugin

Open your Vim or Neovim configuration file and add the following lines:

Save the configuration file and restart your editor or run :source ~/.vimrc (for Vim) or :source ~/.config/nvim/init.vim (for Neovim) to load the changes.

Step 4: Verify the Installation

Open Vim or Neovim, and you should now have the "vim-bitoai" plugin installed and ready to use.

Usage

You can use its powerful features once you have installed the "vim-bitoai" plugin. Here are some of the available commands:

  • BitoAiGenerate: Generates code based on a given prompt.

  • BitoAiGenerateUnit: Generates unit test code for the selected code block.

  • BitoAiGenerateComment: Generates comments for methods, explaining parameters and output.

  • BitoAiCheck: Performs a check for potential issues in the code and suggests improvements.

To execute a command, follow these steps:

  1. Open a file in Vim or Neovim that you want to work on.

  2. Select the code block you want to act on. You can use visual mode or manually specify the range using line numbers.

  3. Execute the desired command by running the corresponding command in command mode. For example, to generate code based on a prompt, use the : BitoAiGenerate command. Note: Some commands may prompt you for additional information or options.

By leveraging the "vim-bitoai" plugin, you can directly harness the power of Bito's AI capabilities within your favorite Vim or Neovim editor. This integration lets you streamline your software development process, saving time and effort in repetitive tasks and promoting efficient coding practices.

Customization

The "vim-bitoai" plugin also offers customization options tailored to your specific needs. Here are a few variables you can configure in your Vim or Neovim configuration file:

  • g:bito_buffer_name_prefix: Sets the prefix for the buffer name in the Bito history. By default, it is set to 'bito_history_'.

  • g:vim_bito_path: Specifies the path to the Bito CLI executable. If the Bito CLI is not in your system's command path, you can provide the full path to the executable.

  • g:vim_bito_prompt_{command}: Allows you to customize the prompt for a specific command. Replace {command} with the desired command.

To define a custom prompt, add the following line to your Vim or Neovim configuration file and replace your prompt with the desired prompt text:

Remember to restart your editor or run the appropriate command to load the changes.

We encourage you to explore the "vim-bitoai" plugin and experience the benefits of seamless integration between Bito and your Vim or Neovim editor. Feel free to contribute to the repository or provide feedback to help us further improve this plugin and enhance your coding experience.

git clone https://github.com/zhenyangze/vim-bitoai.git
  • BitoAiCheckSecurity: Checks the code for security issues and provides recommendations.

  • BitoAiCheckStyle: Checks the code for style issues and suggests style improvements.

  • BitoAiCheckPerformance: Analyzes the code for performance issues and suggests optimizations.

  • BitoAiReadable: Organizes the code to enhance readability and maintainability.

  • BitoAiExplain: Generates an explanation for the selected code.

  • The plugin will communicate with the Bito CLI and execute the command, providing the output directly within your editor.
    " Vim Plug
    Plug 'zhenyangze/vim-bitoai'
    
    " NeoBundle
    NewBundle 'zhenyangze/vim-bitoai'
    
    " Vundle
    Plugin 'zhenyangze/vim-bitoai'
    if !exists("g:vim_bito_prompt_{command}")
        let g:vim_bito_prompt_{command}="your prompt"
    endif
    How to install Bito extension on VS Code
    How to install Bito extension on JetBrains IDEs