tabby/clients/eclipse
2024-09-03 18:38:02 -07:00
..
docs docs(eclipse): add export archive in readme. (#3017) 2024-08-30 00:33:26 +08:00
feature refactor(eclipse): refactor the inline completion trigger. (#3060) 2024-09-03 18:38:02 -07:00
plugin refactor(eclipse): refactor the inline completion trigger. (#3060) 2024-09-03 18:38:02 -07:00
scripts fix(eclipse): include tabby-agent in package. (#2732) 2024-07-26 11:54:27 +08:00
.gitignore fix(eclipse): include tabby-agent in package. (#2732) 2024-07-26 11:54:27 +08:00
package.json docs(eclipse): fix readme step build tabby-agent. (#2846) 2024-08-12 08:55:28 -07:00
README.md docs(eclipse): add export archive in readme. (#3017) 2024-08-30 00:33:26 +08:00

Tabby Plugin for Eclipse

Note: This repository is currently undergoing extensive development.

Development Setup

  1. Install Eclipse with the Plug-in Development Environment (PDE). It is recommended to download the Eclipse IDE for Eclipse Committers for a more streamlined setup.

  2. Ensure you have Node.js version 18 or higher installed. For package management, install pnpm. Using corepack is the preferred method for installation.

  3. Clone the Tabby repository and install its dependencies:

    git clone https://github.com/TabbyML/tabby.git
    cd tabby
    pnpm install
    cd clients/eclipse
    pnpm turbo build
    

    This process will also build the tabby-agent and place it into the clients/eclipse/plugin/tabby-agent/ directory.

  4. Import the project into your Eclipse workspace.
    a. Open File -> Import..., select the General -> Existing Projects into Workspace option, and click Next.
    Import Project into Workspace
    b. Select the clients/eclipse/plugin as the root directory, check the item to be imported, and click Finish.
    Import Project into Workspace
    c. Then import the clients/eclipse/feature directory as well.

  5. Open the clients/eclipse/plugin/plugin.xml file in Eclipse. It should open as a plugin project overview. In the Testing section, click on Launch an Eclipse application to start the plugin.
    Launch an Eclipse application

Export a ZIP Archive

  1. In Eclipse, open File -> Export..., select the Plug-in Development -> Deployable features option, and click Next.
    Export Archive
  2. Check the com.tabbyml.features.tabby4eclipse, then select Archive file with a specified file path, and click Finish. Export Archive
  3. The exported ZIP archive should be located at the specified file path. It can be installed by navigating to Help -> Install New Software....