CLI#
本节列出并描述了 argilla CLI 应用程序提供的命令。如果您需要更多关于 CLI 中可用命令的信息，您可以使用 --help 选项
argilla --help
如果您需要更多关于特定命令的信息，您也可以使用 --help 选项
argilla users create --help
登录#
argilla login 命令用于存储用户的本地凭据，主要目的是重用这些凭据以在 Argilla 服务器中自动进行身份验证，从而运行其他命令或使用 Argilla 的 Python 脚本。
argilla login --api-url https://127.0.0.1:6900
注意
为了验证提供的 URL 和 API 密钥是否有效，login 命令将尝试使用提供的凭据连接到 Argilla 服务器。
注意
默认情况下，Argilla 将使用 ~/.cache/argilla 目录来存储本地凭据。如果您想更改此行为，您可以使用 ARGILLA_CACHE_DIR 环境变量设置有效的目录。
注销#
argilla logout 命令删除先前通过调用 argilla login 命令生成的已存储本地凭据。
argilla logout
注意
logout 将尝试在删除存储的凭据之前连接到 Argilla 服务器。 如果由于某些原因 Argilla 服务器不可用，但您仍然想要删除存储的凭据，则可以使用 --force 选项。
Whoami#
argilla whoami 命令打印已登录用户的信息（用户名、工作区、API 密钥等）。
argilla whoami
Info#
argilla info 命令打印 Python 客户端、Argilla 服务器和 ElasticSearch 服务器的版本，这些版本可能对调试目的或报告问题很有用。
argilla info
用户#
argilla users 命令组提供用于管理连接的 Argilla 服务器用户的基本操作。
创建用户#
argilla users create 命令允许您从命令行轻松创建新用户。 该命令将提示输入新用户的用户名和密码，但可以提供以下选项
--username：新用户的用户名。--password：新用户的密码。--first-name：新用户的名字。 如果未提供，将使用用户名。--last-name：新用户的姓氏。--role：新用户的角色。 默认值为annotator。--workspace：新用户将被添加到其中的工作区的名称。 可以多次提供以将用户添加到多个工作区。
argilla users create --username joe --first-name Joe --last-name Doe --role admin --workspace workspace1 --workspace workspace2
删除用户#
argilla users delete 命令允许您通过提供要删除的用户的用户名，从命令行轻松删除现有用户。
argilla users delete joe
列出用户#
argilla users list 命令显示 Argilla 服务器中注册用户的列表。 可选地，可以提供 --workspace 选项以仅显示属于特定工作区的用户。
argilla users list
工作区#
argilla workspaces 命令组提供用于管理连接的 Argilla 服务器工作区的基本操作。 此命令组中在特定工作区中执行操作的命令需要提供 --name 选项来指定将在其中执行操作的工作区。
创建工作区#
argilla workspaces create 命令允许您从命令行轻松创建新工作区。
argilla workspaces create my-new-workspace
将用户添加到工作区#
argilla workspaces add-user 命令允许您通过提供用户的用户名和工作区的名称，将用户添加到工作区。
argilla workspaces --name my-workspace add-user joe
从工作区删除用户#
argilla workspaces delete-user 命令允许您通过提供用户的用户名和工作区的名称，从工作区中删除用户。
argilla workspaces --name my-workspace delete-user joe
列出工作区#
argilla workspaces list 命令显示 Argilla 服务器中工作区的列表。
argilla workspaces list
数据集#
argilla datasets 命令组提供用于管理存储在连接的 Argilla 服务器中的数据集的基本操作。 此命令组中在特定数据集中执行操作的命令需要提供 --name 选项，并可选地提供 --workspace 选项以指定数据集存储在哪个工作区中。 如果未提供 --workspace 选项，则将使用存储在本地凭据中的工作区。
删除数据集#
argilla datasets delete 命令允许您通过提供数据集的名称以及可选的工作区（数据集存储在其中），从 Argilla 服务器中删除 FeedbackDataset。
argilla datasets --name my-dataset --workspace my-workspace delete
列出数据集#
argilla datasets list 显示 Argilla 服务器中存储的数据集列表。 可以提供以下选项
--workspace：将从中列出数据集的工作区的名称。 如果未提供，将列出所有工作区的所有数据集。--type：要列出的数据集的类型。 两个可能的值：feedback和other（用于TextClassification、TokenClassification和Text2Text数据集）。
argilla datasets list
服务器#
argilla server 命令组包含用于管理 Argilla 服务器及其数据库的命令。
注意
仅当 Argilla 安装了服务器所需的依赖项时，此命令组才可用（使用 pip install argilla[server]）。
启动服务器#
argilla server start 命令将启动 Argilla 服务器并阻塞当前终端。 可以提供以下选项
--host：Argilla 服务器将绑定到的主机。 默认值为0.0.0.0。--port：Argilla 服务器将绑定到的端口。 默认值为6900。--access-log/--no-access-log：启用/禁用服务器访问日志。 默认值为True。
数据库管理#
argilla server database 命令组提供用于管理 Argilla 服务器数据库的功能
argilla server database migrate：应用数据库迁移。argilla server database revisions：列出数据库可以迁移到的不同修订版本。
使用数据库连接的用户管理#
argilla server database users 命令组提供用于管理 Argilla 服务器用户的功能。 为此，argilla server database users 命令使用数据库连接而不是 Argilla API，因此这些命令必须从可以访问数据库的计算机执行。 要设置命令将使用的数据库 URL，请查看 SQLite 和 PostgreSQL 部分。
argilla server database users create：在 Argilla 服务器数据库中创建新用户。argilla server database users create_default：在 Argilla 服务器数据库中创建默认用户。argilla server database users migrate：将用户从旧的YAML文件迁移到 Argilla 服务器数据库。argilla server database users update：在 Argilla 服务器数据库中更新用户。