Menu

Tree [766879] master /
 History

HTTPS access


File Date Author Commit
 .vscode 2023-09-05 allen-li1231 allen-li1231 [f284d3] provide easy debug settings for vscode extension
 assets 2023-08-21 rjmacarthy rjmacarthy [87dbdb] initial commit
 src 2023-09-08 rjmacarthy rjmacarthy [3d9601] revert
 .editorconfig 2023-08-21 rjmacarthy rjmacarthy [87dbdb] initial commit
 .eslintrc.cjs 2023-08-21 rjmacarthy rjmacarthy [87dbdb] initial commit
 .gitignore 2023-08-21 rjmacarthy rjmacarthy [87dbdb] initial commit
 .prettierrc 2023-08-21 rjmacarthy rjmacarthy [87dbdb] initial commit
 .vscodeignore 2023-08-21 rjmacarthy rjmacarthy [87dbdb] initial commit
 LICENSE 2023-08-25 rjmacarthy rjmacarthy [f0df5d] update licence
 README.md 2023-08-29 rjmacarthy rjmacarthy [dab5ca] update README.md
 package-lock.json 2023-09-08 rjmacarthy rjmacarthy [d03d62] 0.1.9
 package.json 2023-09-08 rjmacarthy rjmacarthy [d03d62] 0.1.9
 tsconfig.json 2023-08-21 rjmacarthy rjmacarthy [87dbdb] initial commit
 webpack.config.js 2023-08-21 rjmacarthy rjmacarthy [87dbdb] initial commit

Read Me

twinny

twinny is a locally hosted AI code completion plugin for Visual Studio Code, designed to work seamlessly with the twinny-api.

twinny is aptly named as your "twin" pair programmer, assisting you in writing code more efficiently and intelligently.

🎉 Attention: twinny now supports CodeLlama! 🎉

twinny

The aim of twinny is to democratise the development of AI code completion tools, join me on this journey!

🚀 Getting Started

Prerequisites

To make use of twinny properly, you will need to run the twinny-api. This is the server which serves the extension with code completion suggestions.

Follow the instructions here on how to install and run the server on your computer first.

Installation & Setup

Once you have twinny-api up and running you will need to install the extension.

You can install the verified extension using vscode or visit this link for more information on how to install it.

Enjoy enhanced code completions with twinny! 🎉

Development and contributions

  1. Clone this repository:
git clone https://github.com/rjmacarthy/twinny.git
  1. Navigate to the cloned directory:
cd twinny
  1. Install the necessary dependencies:
npm install
  1. Start the plugin in development mode by pressing F5 within Visual Studio Code.

Contributions are welcome for both the extension and the API please open an issue describing your changes and open a pull request when ready.

This project is under MIT licence, please read the LICENSE file for more information.