tabbyml/tabby

Tabby 镜像文档

镜像概述

Tabby是一款自托管的AI代码助手，提供开源本地部署方案，作为GitHub Copilot的替代选择。它旨在企业私有环境中提供安全可控的代码辅助能力，无需依赖外部数据库或云服务，可直接集成到现有开发工具链中。

核心功能与特性

核心优势

• 自包含架构：无需数据库管理系统(DBMS)或云服务支持，独立运行
• 开放集成能力：提供OpenAPI接口，易于与现有基础设施（如Cloud IDE、内部开发平台）集成
• 硬件兼容性：支持消费级GPU运行，降低部署门槛

关键功能

• 代码补全：基于上下文感知的实时代码建议，支持多种编程语言
• 聊天交互：通过侧边栏聊天面板提供代码解释、调试建议等功能，支持@菜单快速引用文件或上下文
• 文档增强：通过REST API集成自定义文档，提升代码理解能力
• 团队协作：支持索引GitLab Merge Request作为上下文，共享代码解答和讨论
• 安全认证：内置LDAP认证，保障私有环境访问安全
• 数据持久化：支持将聊天记录、解答转化为可共享的持久化页面

最新版本特性（v0.30及以上）

• 支持索引GitLab Merge Request作为上下文
• 增强的@菜单功能，支持在聊天中快速引用文件和资源
• 背景任务通知机制，提升用户体验
• 代码浏览器体验优化，支持仓库上下文感知

使用场景

• 企业内部开发：在私有网络环境中提供AI代码辅助，保护知识产权
• 教育机构：搭建本地代码学习助手，无需外部API依赖
• 开发团队协作：共享代码解答、调试经验，提升团队效率
• Cloud IDE集成：作为后端服务集成到云开发环境，提供实时代码补全
• 低配置环境部署：支持消费级GPU，适合中小型团队或个人开发者

使用方法

快速启动（Docker Run）

通过以下命令可在1分钟内启动Tabby服务：

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

参数说明：

• --gpus all：使用所有可用GPU（若使用CPU可移除该参数）
• -p 8080:8080：端口映射，将容器8080端口映射到主机8080端口
• -v $HOME/.tabby:/data：数据持久化，将模型、配置等数据存储到主机$HOME/.tabby目录
• --model：指定代码补全模型（如StarCoder-1B、CodeLlama等）
• --device：指定运行设备（cuda使用GPU，cpu使用CPU，mps支持Apple Metal）
• --chat-model：指定聊天交互模型（如Qwen2-1.5B-Instruct、Code***等）

配置参数

扩展部署（Docker Compose）

创建docker-compose.yml文件，配置持久化和自定义参数：

yaml
version: '3'
services:
  tabby:
    image: docker.xuanyuan.run/tabbyml/tabby
    ports:
      - "8080:8080"
    volumes:
      - ./tabby-data:/data
    deploy:
      resources:
        reservations:
          devices:
            - driver: nvidia
              count: all
              capabilities: [gpu]
    command: >
      serve 
      --model StarCoder-7B 
      --device cuda 
      --chat-model CodeLlama-7B-Chat 
      --port 8080

启动服务：

bash
docker-compose up -d

集成与扩展

IDE插件支持

Tabby提供多平台IDE插件，包括：

• VS Code（支持@提及文件作为上下文、右键编辑功能）
• JetBrains系列（IntelliJ, PyCharm等）
• Vim/Neovim

API集成

通过OpenAPI接口可将Tabby集成到自定义开发工具中，具体文档参见官方API文档。

版本更新日志

• v0.30.0（2025-07-02）：支持索引GitLab Merge Request作为上下文
• v0.29.0（2025-05-20）：通过REST API增强自定义文档集成
• v0.24.0（2025-02-05）：新增LDAP认证和后台任务通知
• v0.23.0（2025-01-10）：优化代码浏览器和聊天面板体验
• v0.22.0（2024-12-24）：引入通知框功能

更多版本详情参见https://github.com/TabbyML/tabby/releases%E3%80%82