tiger-cli

🚀 Tiger CLI

Tiger CLI 是 Tiger Cloud 的命令行界面。它提供了用于管理和查询数据库服务的命令，以及一个集成的模型上下文协议（Model Context Protocol，MCP）服务器，供 AI 助手使用。

🚀 快速开始

安装 Tiger CLI 后，使用你的 Tiger Cloud 账户进行身份验证：

# 登录到你的 Tiger 账户
tiger auth login

# 查看可用命令
tiger --help

# 列出你的数据库服务
tiger service list

# 创建一个新的数据库服务
tiger service create --name my-database

# 获取连接字符串
tiger db connection-string

# 连接到你的数据库
tiger db connect

# 安装 MCP 服务器
tiger mcp install

✨ 主要特性

• 提供多种安装方式，方便不同系统和环境的用户使用。
• 支持对数据库服务的全生命周期管理，包括创建、启动、停止、删除等操作。
• 集成了 MCP 服务器，使 AI 助手能够与 Tiger Cloud 基础设施进行交互。
• 支持灵活的配置管理，可通过配置文件、环境变量和命令行标志进行设置。

📦 安装指南

提供了多种安装方法。请从以下选项中选择你喜欢的方法。如果你不确定，建议使用第一种！

安装脚本（macOS/Linux/WSL）

curl -fsSL https://cli.tigerdata.com | sh

安装脚本（Windows）

irm https://cli.tigerdata.com/install.ps1 | iex

Homebrew（macOS/Linux）

brew install --cask timescale/tap/tiger-cli

Debian/Ubuntu

# 添加仓库
curl -s https://packagecloud.io/install/repositories/timescale/tiger-cli/script.deb.sh | sudo os=any dist=any bash

# 安装 tiger-cli
sudo apt-get install tiger-cli

手动仓库安装说明请见此处。

Red Hat/Fedora

# 添加仓库
curl -s https://packagecloud.io/install/repositories/timescale/tiger-cli/script.rpm.sh | sudo os=rpm_any dist=rpm_any bash

# 安装 tiger-cli
sudo yum install tiger-cli

手动仓库安装说明请见此处。

Go 安装

go install github.com/timescale/tiger-cli/cmd/tiger@latest

💻 使用示例

基础用法

Tiger CLI 提供了以下命令：

# 认证管理
tiger auth login  # 登录到你的 Tiger 账户
tiger auth logout # 从你的 Tiger 账户注销
tiger auth status # 显示当前认证状态和项目 ID

# 服务生命周期管理
tiger service list # 列出所有服务
tiger service create --name my-service # 创建一个新服务
tiger service get my-service # 显示服务详细信息（别名: describe, show）
tiger service fork my-service # 复制一个现有服务
tiger service start my-service # 启动一个已停止的服务
tiger service stop my-service # 停止一个正在运行的服务
tiger service delete my-service # 删除一个服务
tiger service update-password my-service # 更新服务的主密码

# 数据库操作
tiger db connect my-service # 使用 psql 连接到数据库
tiger db connection-string my-service # 获取服务的连接字符串
tiger db test-connection my-service # 测试数据库连接

# 配置管理
tiger config show # 显示当前配置
tiger config set output json # 设置配置值
tiger config unset output # 移除配置值
tiger config reset # 将配置重置为默认值

# MCP 服务器设置和管理
tiger mcp install # 为 AI 助手安装和配置 MCP 服务器
tiger mcp start # 启动 MCP 服务器
tiger mcp list # 列出可用的 MCP 工具、提示和资源

# 显示版本信息
tiger version

使用 tiger <命令> --help 可获取每个命令的详细信息。

📚 详细文档

MCP 服务器

Tiger CLI 包含一个模型上下文协议（MCP）服务器，该服务器使 Claude Code 等 AI 助手能够与你的 Tiger Cloud 基础设施进行交互。MCP 服务器提供了对数据库服务和操作的编程访问。

安装

为你的 AI 助手配置 MCP 服务器：

# 交互式安装（提示选择客户端）
tiger mcp install

# 或者直接指定你的客户端
tiger mcp install claude-code    # Claude Code
tiger mcp install codex          # Codex
tiger mcp install cursor         # Cursor IDE
tiger mcp install gemini         # Gemini CLI
tiger mcp install vscode         # VS Code
tiger mcp install windsurf       # Windsurf

安装完成后，重启你的 AI 助手以激活 Tiger MCP 服务器。

手动安装

如果 tiger mcp install 不支持你的 MCP 客户端，请按照客户端的说明安装 MCP 服务器。使用 tiger mcp start 作为启动 MCP 服务器的命令。例如，许多客户端使用如下所示的 JSON 文件：

{
  "mcpServers": {
    "tiger": {
      "command": "tiger",
      "args": [
        "mcp",
        "start"
      ]
    }
  }
}

可流式传输的 HTTP 协议

上述说明使用 stdio 传输安装 MCP 服务器。如果你需要使用可流式传输的 HTTP 传输，可以使用 tiger mcp start http --port 8080 启动服务器，并使用 http://localhost:8080 作为 URL 将其安装到你的客户端中。

可用的 MCP 工具

MCP 服务器向 AI 助手公开了以下工具：

服务管理：

• service_list - 列出你项目中的所有数据库服务
• service_get - 获取特定服务的详细信息
• service_create - 创建具有可配置资源的新数据库服务
• service_fork - 复制一个现有的数据库服务以创建独立副本
• service_start - 启动一个已停止的数据库服务
• service_stop - 停止一个正在运行的数据库服务
• service_update_password - 更新服务的主密码

数据库操作：

• db_execute_query - 对数据库服务执行 SQL 查询，支持参数化查询、自定义超时和连接池

MCP 服务器会自动使用你的 CLI 认证和配置，因此除了 tiger auth login 之外，无需额外设置。

代理工具

除了上述服务管理工具之外，Tiger MCP 服务器还代理来自远程文档 MCP 服务器的工具。此功能为 AI 助手提供了对 PostgreSQL、TimescaleDB 和 Tiger Cloud 文档的语义搜索功能，以及各种 Tiger Cloud 功能的提示/指南。

代理文档服务器 (pg-aiguide) 当前提供以下工具：

• view_skill - 获取 TimescaleDB 功能和最佳实践的综合指南
• semantic_search_postgres_docs - 使用自然语言查询搜索 PostgreSQL 文档
• semantic_search_tiger_docs - 使用自然语言查询搜索 Tiger Cloud 和 TimescaleDB 文档

此代理连接默认启用，无需额外配置。

要禁用文档代理：

tiger config set docs_mcp false

配置

CLI 默认将配置存储在 ~/.config/tiger/config.yaml 中，并支持通过环境变量和命令行标志进行分层配置。

# 显示当前配置
tiger config show

# 设置配置值
tiger config set output json

# 移除配置值
tiger config unset output

# 重置为默认值
tiger config reset

配置选项

所有配置选项都可以通过 tiger config set <键> <值> 进行设置：

• analytics - 启用/禁用分析（默认: true）
• color - 启用/禁用彩色输出（默认: true）
• debug - 启用/禁用调试日志（默认: false）
• docs_mcp - 启用/禁用文档 MCP 代理（默认: true）
• output - 输出格式：json、yaml 或 table（默认: table）
• password_storage - 密码存储方法：keyring、pgpass 或 none（默认: keyring）
• service_id - 默认服务 ID
• version_check_interval - CLI 检查新版本的频率，0 表示禁用（默认: 24h）

环境变量

环境变量会覆盖配置文件的值。所有变量都使用 TIGER_ 前缀：

• TIGER_ANALYTICS - 启用/禁用分析
• TIGER_COLOR - 启用/禁用彩色输出
• TIGER_CONFIG_DIR - 配置目录的路径（默认: ~/.config/tiger）
• TIGER_DEBUG - 启用/禁用调试日志
• TIGER_DOCS_MCP - 启用/禁用文档 MCP 代理
• TIGER_OUTPUT - 输出格式：json、yaml 或 table
• TIGER_PASSWORD_STORAGE - 密码存储方法：keyring、pgpass 或 none
• TIGER_PUBLIC_KEY - 用于认证的公钥（优先于存储的凭证）
• TIGER_SECRET_KEY - 用于认证的私钥（优先于存储的凭证）
• TIGER_SERVICE_ID - 默认服务 ID
• TIGER_VERSION_CHECK_INTERVAL - CLI 检查新版本的频率，0 表示禁用

全局标志

这些标志可用于所有命令，并且优先于环境变量和配置文件的值：

• --analytics - 启用/禁用分析
• --color - 启用/禁用彩色输出
• --config-dir <路径> - 配置目录的路径（默认: ~/.config/tiger）
• --debug - 启用/禁用调试日志
• --password-storage <方法> - 密码存储方法：keyring、pgpass 或 none
• --service-id <ID> - 指定服务 ID
• --skip-update-check - 启动时跳过更新检查（默认: false）
• -h, --help - 显示帮助信息

🔧 技术细节

配置存储

CLI 默认将配置存储在 ~/.config/tiger/config.yaml 中，并且支持通过环境变量和命令行标志进行分层配置。这种设计使得用户可以根据不同的环境和需求灵活地调整配置。

MCP 服务器

MCP 服务器集成在 Tiger CLI 中，它使用 CLI 的认证和配置信息，使得 AI 助手能够与 Tiger Cloud 基础设施进行交互。MCP 服务器提供了一系列工具，包括服务管理和数据库操作工具，同时还支持对文档的语义搜索功能。

代理功能

Tiger MCP 服务器代理来自远程文档 MCP 服务器的工具，为 AI 助手提供了更丰富的功能。默认情况下，代理连接是启用的，用户可以通过配置选项禁用该功能。

📄 许可证

本项目采用 Apache 许可证 2.0 版 - 详情请参阅 LICENSE 文件。

🤝 贡献

我们欢迎贡献！以下是开始贡献的步骤：

1. 分叉仓库
2. 创建功能分支
3. 进行更改
4. 为新功能添加测试
5. 确保所有测试通过 (go test ./...)
6. 提交拉取请求

有关详细的开发信息，请参阅 docs/development.md。