Trieve CLI - README

概述

Trieve CLI 是一个用于与 Trieve 搜索产品交互的命令行界面 (CLI)。它允许用户通过命令行配置配置文件、管理 API 密钥、处理数据集以及直接与组织交互。

安装

要安装 Trieve CLI，您需要在您的计算机上安装 Rust。如果您尚未安装它，可以使用以下命令安装：

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

然后，您可以从 Cargo 安装 CLI

cargo install trieve

构建项目后，您可以使用 trieve 命令运行 CLI。

用法

要使用 Trieve CLI，您需要首先使用您的凭证配置它。

trieve login

然后，您可以使用任何可用的命令与 Trieve 服务交互。

功能

通用

• 配置文件管理：切换、删除和列出不同配置的配置文件。
• API 密钥管理：为访问 Trieve 服务生成新的 API 密钥。
• 数据集管理：创建、列出、删除数据集以及向数据集添加种子数据。
• 组织管理：在不同组织之间切换。

命令

通用结构

trieve <command> [subcommand] [flags]

注意：所有这些命令都是交互式的，即使在未传递标志的情况下也能工作。

命令和子命令

1. 登录

   trieve login --api-key <API_KEY> [--api-url <API_URL>] [--profile-name <PROFILE_NAME>]
   

   使用您的 API 密钥配置 Trieve CLI。

2. 数据集

   trieve dataset <subcommand> [flags]
   

   • 创建

     trieve dataset create --name <DATASET_NAME>
     

     在 Trieve 服务中创建数据集。

   • 列出

     trieve dataset list
     

     列出 Trieve 服务中的所有数据集。

   • 删除

     trieve dataset delete --dataset-id <DATASET_ID>
     

     删除 Trieve 服务中的数据集。

   • 示例（添加种子数据）

     trieve dataset example --dataset-id <DATASET_ID>
     

     向 Trieve 服务中的数据集添加种子数据。

3. API 密钥

   trieve apikey <subcommand> [flags]
   

   • 生成

     trieve apikey generate --name <API_KEY_NAME> --role <API_KEY_ROLE>
     

     生成新的 API 密钥。

4. 配置文件

   trieve profile <subcommand> [flags]
   

   • 切换

     trieve profile switch --profile-name <PROFILE_NAME>
     

     切换到不同的配置文件。

   • 删除

     trieve profile delete --profile-name <PROFILE_NAME>
     

     删除配置文件。

   • 列出

     trieve profile list
     

     列出所有配置文件。

5. 组织

   trieve organization <subcommand> [flags]
   

   • 切换

     trieve organization switch --organization-id <ORGANIZATION_ID>
     

     切换到不同的组织。

贡献

欢迎贡献！请克隆仓库并提交带有您更改的 pull request。

许可证

本项目采用 MIT 许可证。有关详细信息，请参阅 LICENSE 文件。

联系

如有任何问题或问题，请在 GitHub 仓库中打开问题或联系维护者。

本README文件提供了Trieve CLI的基本概述及其功能。有关详细使用方法和示例，请运行trieve <命令> --help查看特定命令的帮助信息。