Git Product home page Git Product logo

steveefemsc / twinny Goto Github PK

View Code? Open in Web Editor NEW

This project forked from rjmacarthy/twinny

1.0 0.0 0.0 1.26 MB

The most no-nonsense locally hosted (or API hosted) AI code completion plugin for Visual Studio Code, like GitHub Copilot but 100% free and 100% private.

Home Page: https://marketplace.visualstudio.com/items?itemName=rjmacarthy.twinny

License: MIT License

JavaScript 1.71% TypeScript 75.03% CSS 23.25%

twinny's Introduction

twinny

Are you fed up of all of those so called "free" Copilot alternatives with paywalls and signups? Fear not my developer friend! Twinny is the most no-nonsense locally hosted (or api hosted) AI code completion plugin for Visual Studio Code designed to work seamlessly with Ollama, llama.cpp and LM Studio. Like Github Copilot but 100% free and 100% private.

Install the twinny Visual Studio Code extension

Main features

Fill in the middle code completion:

Chat with AI about your code

Other features

  • Configurable single or multiline fill-in-middle completions
  • Configurable prompt templates add, edit, remove, delete and set as default
  • Easy installation and setup
  • Ollama, llamacpp and LM Studio API compatible
  • Accept code solutions directly to editor
  • Create new documents from code blocks
  • Copy generated code solution blocks
  • Chat history preserved per workspace

๐Ÿš€ Getting Started

Easy Installation

Install the verified extension at this link or find the extension in the extensions section of Visual Studio Code marketplace.

Twinny is configured to use Ollama by deafult. Therefore, when installing the twinny extension in Visual Studio Code, it will automatically prompt and guide you through the installation of Ollama using two default small models codellama:7b-instruct for chat and codellama:7b-code for "fill in the middle" completions.

If you already have Ollama installed or you want to use llama.cpp or LM Studio instead, you can cancel the automatic setup of Ollama and proceed to update the values inside twinny extension settings to point to your existing models and server. At this point it's a good idea to set Disable Server Checks option to true which this will disable the checks on startup.

You can find the settings inside the extension sidebar by clicking the gear icon inside the twinny sidebar or by searching for twinny in the extensions search bar.

When choosing an API provider the port and API path names will be updated automatically based on the provider you choose to use.

If you are using llama.cpp - The twinny settings for FIM model name and Chat model name will be ignored, as this should already be configured when running the llama.cpp server.

When the extension is ready you will see a ๐Ÿค– icon at the bottom of your code editor.

Enjoy enhanced code completions and chat with twinny! ๐ŸŽ‰

Model support

FIM

  • If using Llama the model must support the llama special tokens for prefix and suffix if using codellama models.
  • If using deepseek only use base models for FIM completions for example deepseek-coder:base and deepseek-coder:6.7b-base-q5_K_M
  • stable-code:code has been tested and works for FIM.

Chat

  • All instruct models should work but prompt templates might need editing if using something other than codellama.

Keyboard shortcuts

Shortcut Description
ALT+\ Trigger inline code completion
CTRL+SHIFT+t Open twinny sidebar
CTRL+SHIFT+/ Stop code generation

Known issues

  • If the server settings are incorrectly set chat and fim completion will not work, if this is the case please open an issue with your error message.
  • Some models may not support the special tokens of Llama which means they would not work correctly for FIM completions.
  • Sometimes a restart of vscode is required for new settings to take effect.
  • Using file context often causes unreliable completions for FIM because small models get confused when provided with more than one file context.
  • See open issues for more information

If you have a suggestion for improvement please open an issue and I will do my best to make it happen!

Contributing

We are actively looking for contributors who want to help improve the project, if you are interested in helping out please reach out on twitter.

Contributions are welcome 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.

twinny's People

Contributors

rjmacarthy avatar allen-li1231 avatar badetitou avatar winniep avatar antonkrug avatar sbeardsley avatar oxaronick avatar

Stargazers

Brian Roach avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.