TiDB Cloud Filesystem CLI 命令参考

使用 ti fs 可以预配 TiDB Cloud Filesystem 资源，并通过命令或本地挂载访问其中的数据。

在命令语法中，方括号（[]）表示可选项。圆括号用于对必选项进行分组，竖线（|）用于分隔可选分支。例如，(--ttl <duration> | --no-expiration) 表示你必须且只能指定这两个选项中的一个。

资源和令牌命令

命令	描述
`create-file-system`	创建一个 Filesystem 及其初始所有者令牌。
`list-file-systems`	列出当前生效 Region 中的 Filesystem。
`describe-file-system`	按 ID 描述一个 Filesystem。
`check-file-system`	检查 Filesystem 选择、路由、凭证以及数据平面访问。
`delete-file-system`	永久删除一个 Filesystem。
`import-file-system-token`	在本地导入并选中一个现有的 Filesystem 访问令牌。
`generate-file-system-token`	生成一个额外的所有者令牌。
`generate-file-system-scoped-token`	生成一个受路径、操作和有效期限制的令牌。
`list-file-system-tokens`	列出不含 Secret 的令牌元信息。
`enable-file-system-token`	重新启用已禁用的令牌。
`disable-file-system-token`	临时禁用一个令牌。
`delete-file-system-token`	永久（权限）回收一个令牌。
`refresh-file-system-token`	轮转一个令牌，并一次性返回其替代令牌。

当所有者令牌被授予令牌管理权限后，它可以列出令牌、创建范围受限令牌，并（权限）回收所有者令牌或范围受限令牌。它只能启用或禁用范围受限令牌。TiDB Cloud API 凭证则可以启用、禁用或（权限）回收这两类令牌中的任意一种。

这些命令用于配置可选的提供方，以便从媒体文件中提取内容并生成向量嵌入。普通的 Filesystem 资源和文件操作不需要 AI 提供方配置。

命令	描述
`describe-file-system-extract-configuration`	描述媒体内容提取提供方配置。
`update-file-system-extract-configuration`	修改用于提取媒体内容的提供方。
`describe-file-system-embedding-configuration`	描述向量嵌入提供方配置。
`update-file-system-embedding-configuration`	修改用于生成向量嵌入的提供方。

命令	描述
`copy-file`	在本地存储与 Filesystem 之间，或在 Filesystem 内部复制文件。
`read-file`	读取远程文件或字节范围。
`list-files`	列出远程路径下的条目。
`describe-file`	描述远程文件或目录。
`move-file`	移动或重命名远程路径。
`delete-file`	删除远程文件或目录。
`create-directory`	创建远程目录。
`chmod-file`	修改 POSIX 风格的模式元信息。
`create-symlink`	创建符号链接。
`create-hardlink`	创建硬链接。
`search-file-content`	搜索提取出的文件内容和描述。
`find-files`	按名称、标签、日期、大小或类型查找文件。

层引用可以是层 ID、唯一的层名称，或形如 tag:<key>=<value> 的标签引用，例如 tag:run=123。由于名称和标签引用都可能存在歧义，因此在自动化场景中建议使用层 ID。

本地叠加层用于存储挂载预设保留在本地机器上、而不是写入远程命名空间的文件。挂载预设定义了哪些路径使用该叠加层：

挂载预设	行为
`coding-agent`	将版本控制元信息、依赖关系目录、缓存、构建输出以及常见临时路径保存在本地叠加层中。它不会自动选择打包路径。
`portable`	使用与 `coding-agent` 相同的本地路径规则，并默认对完整叠加层执行打包或解包，因此你可以在不同机器或沙箱会话之间移动它。
`none`	禁用本地叠加层路径路由以及自动打包或解包行为。

以下 ti fs 命令提供 Unix 风格的别名。例如，ti fs cp 等价于 ti fs copy-file。表中未列出的命令（包括 pack-file-system 和 unpack-file-system）没有别名。

别名与规范命令使用相同的选项、认证、输出、查询和错误处理行为。