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
这是什么?Tabby 是一款可自托管的 AI 编程助手,提供开源、可本地部署的替代方案,可替代 GitHub Copilot,具备代码补全和对话功能。
这是代码补全插件,还是需要自己运行的完整服务器?Tabby 是一个需要自行托管的完整服务器组件,并配有 VSCode、Vim 和 IntelliJ 的编辑器扩展;它提供 OpenAPI 接口,因此任何 IDE(包括云端 IDE)都可以与之集成。
怎样才能把 Tabby 服务器跑起来?最快的方式是用一条 Docker 命令启动服务器;如果要从源码构建,需要先配置 Rust 工具链、安装所需的依赖和工具,然后运行 'cargo build'。
运行它一定需要高端 GPU 吗?不需要。Tabby 设计为可在消费级 GPU 上运行推理,并且还新增了对 Apple M1/M2 芯片的 Metal 支持。
哪些编辑器可以真正用上它?Tabby 提供 VSCode、Vim 和 IntelliJ 的 IDE/编辑器扩展,也已上架 JetBrains Marketplace,覆盖最常见的编程环境。
我的代码或数据会离开我的内网吗?不会。Tabby 是自包含的,不需要外部数据库或云服务,因此所有内容都可以完全运行在您自己的基础设施之内。
什么是 Answer Engine?Answer Engine 是 Tabby 的内部知识引擎,它连接开发团队的内部数据(代码、文档、Issue),以提供可靠的答案,并可将这些答案转化为可持久保存、可分享的页面(Pages)。
Tabby 会利用我的代码仓库上下文来提升补全效果吗?会的。从 v0.3 版本开始,Tabby 采用基于 RAG 的代码补全,会结合仓库级上下文、本地 LSP 声明以及最近修改的代码,使建议更加贴切。
Tabby 能运行哪些 AI 模型?Tabby 维护着一个模型注册表,其中包括 CodeLlama、CodeGemma、CodeQwen 以及 Mistral 的 Codestral,并允许您在不同的后端对话模型之间切换。
为什么选择 Tabby,而不是直接使用 GitHub Copilot?Tabby 完全开源且可自托管,您的代码始终留在自己的基础设施上,而不会交由第三方云端处理,同时仍能提供类似 Copilot 的代码补全和对话功能。
Creator
TabbyML
Size
106.7 MB
Stars
33.9K
Age
3y
Commits · 90 Days