cocli

package module
v1.7.0-rc2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 18, 2026 License: Apache-2.0 Imports: 0 Imported by: 0

README

coScene CLI (coCLI) Tests codecov

cocli 是刻行时空(coScene)的命令行工具,方便用户在终端和自动化过程中对刻行时空平台的资源进行管理。完整用法与更多场景见 coScene CLI 文档


安装

curl -fL https://download.coscene.cn/cocli/install.sh | sh

验证安装:

cocli --version

安装指定版本:

curl -fL https://download.coscene.cn/cocli/install.sh | sh -s -- v1.4.4

快速开始

1. 登录认证
cocli login add

根据提示输入 API endpoint 和 token,或使用已有的 profile。

2. 列出项目
cocli project list

(默认只显示第一页,最多 100 条;加 --all 可列出全部项目。)

3. 上传文件到 record
cocli record upload <record-id> ./data/ -p <project-slug>
4. 下载 record 的所有文件
cocli record download <record-id> ./output/ -p <project-slug>

核心场景

数据上传工作流
# 1. 列出可用 projects
cocli project list

# 2. 创建新 record
cocli record create -t <record-title> [-p <project>]

# 3. 上传数据到 record(支持目录、glob 模式)
cocli record upload <record-id> ./data/ [-p <project>]

# 4. 验证上传
cocli record file list <record-id> [-p <project>]
数据下载工作流
# 下载整个 record
cocli record download <record-id> ./output/ [-p <project>]

# 或选择性下载
cocli record file download <record-id> ./output/ --dir logs/ [-p <project>]
项目级文件管理
# 上传资源文件到 project
cocli project file upload <project> ./shared-data/

# 列出和下载
cocli project file list <project>
cocli project file download <project> ./output/

Shell 补全

启用 shell 补全可以自动完成命令、flag 和参数,大幅提升使用体验。

Bash
cocli completion bash | sudo tee /etc/bash_completion.d/cocli
source ~/.bashrc
Zsh
cocli completion zsh > "${fpath[1]}/_cocli"
# 或
cocli completion zsh > ~/.zsh/completions/_cocli

重新加载:

autoload -U compinit && compinit
Fish
cocli completion fish > ~/.config/fish/completions/cocli.fish

高级功能

List 与分页

cocli project listcocli record list 等 list 类命令默认只输出第一页(每页最多 100 条),避免一次性拉取大量数据刷屏。若需全部数据:

  • record list:加 --all 列出所有 record;或按提示用 --page-token 逐页查看。
  • project list:加 --all 列出所有项目;或使用 --page-size--page 分页。

其他 list 子命令(如 record file listproject file list)同理,默认第一页,用 --all 或分页参数获取更多。

环境变量配置(适用于 CI/CD)

对于 Docker 容器或 CI/CD 环境,可以通过环境变量配置,无需交互式登录。以下三项均需设置,才会使用环境变量作为认证来源:

环境变量 描述
COS_ENDPOINT API 端点地址
COS_TOKEN 认证令牌
COS_PROJECT 默认项目 slug

示例:

export COS_ENDPOINT=https://openapi.coscene.cn
export COS_TOKEN=your-api-token
export COS_PROJECT=your-project-slug

cocli record list
Glob 模式上传

使用 glob 模式选择性上传文件:

# 上传目录(保留目录名)
cocli project file upload <project> data/

# 只上传目录内容(不含目录名)
cocli project file upload <project> "data/*"

# 上传特定类型文件
cocli project file upload <project> "logs/*.log"

开发

本地构建
git clone https://github.com/coscene-io/cocli.git
cd cocli
make build-binary
./bin/cocli --version
快速测试
go run cmd/cocli/main.go [command]

帮助与文档

许可证

Apache-2.0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetVersion

func GetVersion() string

GetVersion returns the version information

Types

This section is empty.

Directories

Path Synopsis
api
cmd
cocli command
internal
apimocks
Package apimocks provides mock implementations for API interfaces.
Package apimocks provides mock implementations for API interfaces.
fs
pkg
cmd

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL