tabby README

The project's README from github.com/TabbyML/tabby. As one markdown file: README.md.

🐾 Tabby

📚 Docs • 💬 Slack • 🗺️ Roadmap

latest release PRs Welcome Docker pulls codecov

English | 简体中文 | 日本語

Tabby is a self-hosted AI coding assistant, offering an open-source and on-premises alternative to GitHub Copilot. It boasts several key features:

Open Live Demo

Demo

🔥 What's New

Archived
  • 02/05/2025 LDAP Authentication and better notification for background jobs coming in Tabby v0.24.0!✨
  • 02/04/2025 VSCode 1.20.0 upgrade! @-mention files to add them as chat context, and edit inline with a new right-click option are available!
  • 01/10/2025 Tabby v0.23.0 featuring enhanced code browser experience and chat side panel improvements!
  • 12/24/2024 Introduce Notification Box in Tabby v0.22.0!
  • 12/06/2024 Llamafile deployment integration and enhanced Answer Engine user experience are coming in Tabby v0.21.0!🚀
  • 11/10/2024 Switching between different backend chat models is supported in Answer Engine with Tabby v0.20.0!
  • 10/30/2024 Tabby v0.19.0 featuring recent shared threads on the main page to improve their discoverability.
  • 07/09/2024 🎉Announce Codestral integration in Tabby!
  • 07/05/2024 Tabby v0.13.0 introduces Answer Engine, a central knowledge engine for internal engineering teams. It seamlessly integrates with dev team's internal data, delivering reliable and precise answers to empower developers.
  • 06/13/2024 VSCode 1.7 marks a significant milestone with a versatile Chat experience throughout your coding experience. Come and they the latest chat in side-panel and editing via chat command!
  • 06/10/2024 Latest 📃blogpost drop on an enhanced code context understanding in Tabby!
  • 06/06/2024 Tabby v0.12.0 release brings 🔗seamless integrations (Gitlab SSO, Self-hosted GitHub/GitLab, etc.), to ⚙️flexible configurations (HTTP API integration) and 🌐expanded capabilities (repo-context in Code Browser)!
  • 05/22/2024 Tabby VSCode 1.6 comes with multiple choices in inline completion, and the auto-generated commit messages🐱💻!
  • 05/11/2024 v0.11.0 brings significant enterprise upgrades, including 📊storage usage stats, 🔗GitHub & GitLab integration, 📋Activities page, and the long-awaited 🤖Ask Tabby feature!
  • 04/22/2024 v0.10.0 released, featuring the latest Reports tab with team-wise analytics for Tabby usage.
  • 04/19/2024 📣 Tabby now incorporates locally relevant snippets(declarations from local LSP, and recently modified code) for code completion!
  • 04/17/2024 CodeGemma and CodeQwen model series have now been added to the official registry!
  • 03/20/2024 v0.9 released, highlighting a full feature admin UI.
  • 12/23/2023 Seamlessly deploy Tabby on any cloud with SkyServe 🛫 from SkyPilot.
  • 12/15/2023 v0.7.0 released with team management and secured access!
  • 10/15/2023 RAG-based code completion is enabled by detail in v0.3.0🎉! Check out the blogpost explaining how Tabby utilizes repo-level context to get even smarter!
  • 11/27/2023 v0.6.0 released!
  • 11/09/2023 v0.5.5 released! With a redesign of UI + performance improvement.
  • 10/24/2023 ⛳️ Major updates for Tabby IDE plugins across VSCode/Vim/IntelliJ!
  • 10/04/2023 Check out the model directory for the latest models supported by Tabby.
  • 09/18/2023 Apple's M1/M2 Metal inference support has landed in v0.1.1!
  • 08/31/2023 Tabby's first stable release v0.0.1 🥳.
  • 08/28/2023 Experimental support for the CodeLlama 7B.
  • 08/24/2023 Tabby is now on JetBrains Marketplace!

👋 Getting Started

You can find our documentation here.

Run Tabby in 1 Minute

The easiest way to start a Tabby server is by using the following Docker command:

docker run -it \
  --gpus all -p 8080:8080 -v $HOME/.tabby:/data \
  tabbyml/tabby \
  serve --model StarCoder-1B --device cuda --chat-model Qwen2-1.5B-Instruct

For additional options (e.g inference type, parallelism), please refer to the documentation page.

🤝 Contributing

Full guide at CONTRIBUTING.md;

Get the Code

git clone --recurse-submodules https://github.com/TabbyML/tabby
cd tabby

If you have already cloned the repository, you could run the git submodule update --recursive --init command to fetch all submodules.

Build

  1. Set up the Rust environment by following this tutorial.

  2. Install the required dependencies:

# For MacOS
brew install protobuf

# For Ubuntu / Debian
apt install protobuf-compiler libopenblas-dev
  1. Install useful tools:
# For Ubuntu
apt install make sqlite3 graphviz
  1. Now, you can build Tabby by running the command cargo build.

Start Hacking!

... and don't forget to submit a Pull Request

🌍 Community

🔆 Activity

Git Repository Activity

🌟 Star History

Star History Chart

tabby (TabbyML/tabby)

Searching Database…

33.9K ·GitHub
What is this?Tabby is a self-hosted AI coding assistant that gives you an open-source, on-premises alternative to GitHub Copilot, with code completion and chat features.
Is this a code-completion plugin, or a full server I run myself?Tabby is a full server component you host yourself, paired with editor extensions for VSCode, Vim, and IntelliJ; it exposes an OpenAPI interface so any IDE, including cloud IDEs, can integrate with it.
How do I get a Tabby server running?The fastest way is a single Docker command to start the server; for building from source you set up the Rust toolchain, install the required dependencies and tools, then run 'cargo build'.
Do I need a beefy GPU to run it?No — Tabby is designed to run inference on consumer-grade GPUs, and it even added Metal support for Apple M1/M2 chips.
Which editors can I actually use it with?Tabby ships IDE/editor extensions for VSCode, Vim, and IntelliJ, and is also listed on the JetBrains Marketplace, covering the most common coding environments.
Does my code or data ever leave my network?No — since Tabby is self-contained and doesn't require an external database or cloud service, everything can run entirely inside your own infrastructure.
What is the Answer Engine?Answer Engine is Tabby's internal knowledge engine that connects to a dev team's internal data (code, docs, issues) to give reliable answers, and can turn those answers into persistent, shareable Pages.
Does Tabby use my repository's context for better completions?Yes, since v0.3 Tabby uses RAG-based code completion, pulling in repo-level context, local LSP declarations, and recently modified code to make suggestions more relevant.
Which AI models can Tabby run?Tabby maintains a model registry including CodeLlama, CodeGemma, CodeQwen, and Mistral's Codestral, and lets you switch between backend chat models.
Why pick Tabby over just using GitHub Copilot?Tabby is fully open-source and self-hosted, so your code stays on your own infrastructure instead of a third-party cloud, while still giving you Copilot-like completions and chat.
Creator
TabbyML
Size
106.7 MB
Stars
33.9K
Age
3y
Commits · 90 Days