superthread

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Superthread CLI

Project management CLI for the Superthread API.

基于Superthread API的项目管理CLI工具。

Installation

安装

bash

brew install steveclarke/tap/superthread

bash

brew install steveclarke/tap/superthread

Setup

设置

bash

suth setup

The interactive wizard will:

Prompt for an account name (e.g., "personal" or "work")
Prompt for your API key (from Superthread Settings > API)
Validate and auto-detect your workspace
Save configuration

After setup, try:

bash

suth spaces list
suth boards list -s SPACE
suth cards assigned me

bash

suth setup

交互式向导将：

提示输入账户名称（例如："personal"或"work"）
提示输入你的API密钥（从Superthread设置>API获取）
验证并自动检测你的工作区
保存配置

设置完成后，可尝试：

bash

suth spaces list
suth boards list -s SPACE
suth cards assigned me

Global Options

全局选项

-a, --account NAME    Use specific account for this command
-w, --workspace ID    Workspace ID (or use config/env var)
-y, --yes             Skip confirmation prompts (for scripts/agents)
-v, --verbose         Detailed logging
-q, --quiet           Minimal logging
--json                Output in JSON format (default is table)

-a, --account NAME    本次命令使用指定账户
-w, --workspace ID    工作区ID（或使用配置/环境变量）
-y, --yes             跳过确认提示（适用于脚本/Agent）
-v, --verbose         详细日志输出
-q, --quiet           极简日志输出
--json                以JSON格式输出（默认是表格格式）

Command Reference

命令参考

Accounts

账户

bash

suth accounts list                            # List all configured accounts
suth accounts show                            # Show current account details
suth accounts use NAME                        # Switch to account
suth accounts add NAME                        # Add new account (interactive)
suth accounts remove NAME                     # Remove account

bash

suth accounts list                            # 列出所有已配置的账户
suth accounts show                            # 显示当前账户详情
suth accounts use NAME                        # 切换到指定账户
suth accounts add NAME                        # 添加新账户（交互式）
suth accounts remove NAME                     # 删除账户

Workspaces

工作区

bash

suth workspaces list                          # List available workspaces
suth workspaces use WORKSPACE                 # Set default workspace
suth workspaces current                       # Show current workspace

bash

suth workspaces list                          # 列出可用的工作区
suth workspaces use WORKSPACE                 # 设置默认工作区
suth workspaces current                       # 显示当前工作区

Current User & Members

当前用户与成员

bash

suth me                                       # Get current user info
suth members list                             # List workspace members

bash

suth me                                       # 获取当前用户信息
suth members list                             # 列出工作区成员

Spaces

空间

bash

suth spaces list                              # List all spaces
suth spaces get SPACE [-o]                    # Get space details (--open for browser)
suth spaces create --title "Name"             # Create space
suth spaces update SPACE --title "New Name"   # Update space
suth spaces delete SPACE                      # Delete space
suth spaces add_member SPACE USER [--role ROLE]  # Add member
suth spaces remove_member SPACE USER          # Remove member

bash

suth spaces list                              # 列出所有空间
suth spaces get SPACE [-o]                    # 获取空间详情（--open 用于在浏览器打开）
suth spaces create --title "名称"             # 创建空间
suth spaces update SPACE --title "新名称"   # 更新空间
suth spaces delete SPACE                      # 删除空间
suth spaces add_member SPACE USER [--role ROLE]  # 添加成员
suth spaces remove_member SPACE USER          # 移除成员

Boards

看板

bash

suth boards list -s SPACE                     # List boards in space
suth boards get BOARD [-o]                    # Get board details
suth boards lists BOARD                       # List columns on board
suth boards create -s SPACE --title "Name"    # Create board
suth boards update BOARD --title "New Name"   # Update board
suth boards duplicate BOARD                   # Duplicate board
suth boards delete BOARD                      # Delete board

bash

suth boards list -s SPACE                     # 列出空间内的看板
suth boards get BOARD [-o]                    # 获取看板详情
suth boards lists BOARD                       # 列出看板上的列
suth boards create -s SPACE --title "名称"    # 创建看板
suth boards update BOARD --title "新名称"   # 更新看板
suth boards duplicate BOARD                   # 复制看板
suth boards delete BOARD                      # 删除看板

List (column) management

列管理

suth boards create-list -b BOARD --title "In Progress" suth boards update-list LIST_ID --title "Done" suth boards delete-list LIST_ID

undefined

suth boards create-list -b BOARD --title "进行中" suth boards update-list LIST_ID --title "已完成" suth boards delete-list LIST_ID

undefined

Cards

卡片

bash

suth cards list -b BOARD                      # List cards on a board
  # Options: --space, --list, --include-archived, --since DATE, --updated-since DATE
suth cards get CARD_ID [-o]                   # Get card details (--open for browser)
  # Options: --raw, --no-content
suth cards create --title "Task" -l LIST -b BOARD [options]
  # Options: --content HTML, --parent-card ID, --epic ID,
  #          --sprint SPRINT_ID, --project PROJECT_ID,
  #          --start-date TIMESTAMP, --due-date TIMESTAMP,
  #          --priority N, --owner USER
suth cards update CARD_ID --title "New title" --priority 1
suth cards delete CARD_ID                     # Delete card
suth cards duplicate CARD_ID                  # Duplicate card
suth cards assigned USER                      # Cards assigned to user
suth cards assigned me                        # Cards assigned to me
  # Options: --board, --space, --project, --include-archived,
  #          --since DATE, --updated-since DATE

bash

suth cards list -b BOARD                      # 列出看板上的卡片
  # 选项：--space, --list, --include-archived, --since 日期, --updated-since 日期
suth cards get CARD_ID [-o]                   # 获取卡片详情（--open 用于在浏览器打开）
  # 选项：--raw, --no-content
suth cards create --title "任务" -l LIST -b BOARD [选项]
  # 选项：--content HTML, --parent-card ID, --epic ID,
  #          --sprint SPRINT_ID, --project PROJECT_ID,
  #          --start-date 时间戳, --due-date 时间戳,
  #          --priority N, --owner 用户
suth cards update CARD_ID --title "新标题" --priority 1
suth cards delete CARD_ID                     # 删除卡片
suth cards duplicate CARD_ID                  # 复制卡片
suth cards assigned USER                      # 分配给指定用户的卡片
suth cards assigned me                        # 分配给我的卡片
  # 选项：--board, --space, --project, --include-archived,
  #          --since 日期, --updated-since 日期

Members

成员管理

suth cards assign CARD_ID USER # Assign user suth cards unassign CARD_ID USER # Unassign user

suth cards assign CARD_ID USER # 分配用户 suth cards unassign CARD_ID USER # 取消分配用户

Relationships

关联关系

suth cards link --card CARD --related OTHER --type blocks suth cards unlink --card CARD --related OTHER

suth cards link --card 卡片 --related 关联卡片 --type blocks suth cards unlink --card 卡片 --related 关联卡片

suth projects list                            # List roadmap projects
suth projects get PROJECT_ID [-o]             # Get project details
suth projects create --title "Q1" -l LIST [-b BOARD]
suth projects update PROJECT_ID --title "New"
suth projects delete PROJECT_ID
suth projects add_card PROJECT_ID CARD_ID     # Link card to project
suth projects remove_card PROJECT_ID CARD_ID  # Unlink card

bash

suth projects list                            # 列出路线图项目
suth projects get PROJECT_ID [-o]             # 获取项目详情
suth projects create --title "Q1" -l LIST [-b BOARD]
suth projects update PROJECT_ID --title "新标题"
suth projects delete PROJECT_ID
suth projects add_card PROJECT_ID CARD_ID     # 将卡片关联到项目
suth projects remove_card PROJECT_ID CARD_ID  # 取消卡片与项目的关联

Pages

页面

bash

suth pages list [-s SPACE]                    # List pages
suth pages get PAGE_ID [-o]                   # Get page details
suth pages create -s SPACE [--title "Doc"]    # Create page
suth pages update PAGE_ID --title "New title" # Update page
suth pages duplicate PAGE_ID -s SPACE         # Duplicate page
suth pages archive PAGE_ID                    # Archive page
suth pages delete PAGE_ID                     # Delete page

bash

suth pages list [-s SPACE]                    # 列出页面
suth pages get PAGE_ID [-o]                   # 获取页面详情
suth pages create -s SPACE [--title "文档"]    # 创建页面
suth pages update PAGE_ID --title "新标题" # 更新页面
suth pages duplicate PAGE_ID -s SPACE         # 复制页面
suth pages archive PAGE_ID                    # 归档页面
suth pages delete PAGE_ID                     # 删除页面

Comments

bash

suth comments get COMMENT_ID [-o]             # Get comment (opens parent card)
suth comments create --card CARD --content "Note"
suth comments update COMMENT_ID --content "Updated"
suth comments delete COMMENT_ID

bash

suth comments get COMMENT_ID [-o]             # 获取评论（打开所属卡片）
suth comments create --card 卡片 --content "备注"
suth comments update COMMENT_ID --content "更新后的内容"
suth comments delete COMMENT_ID

Replies

bash

suth replies list COMMENT_ID                  # List replies to a comment
suth replies get REPLY_ID                     # Get reply details
suth replies create COMMENT_ID --content "Reply text"
suth replies update REPLY_ID --content "Updated"
suth replies delete REPLY_ID

bash

suth replies list COMMENT_ID                  # 列出评论的回复
suth replies get REPLY_ID                     # 获取回复详情
suth replies create COMMENT_ID --content "回复内容"
suth replies update REPLY_ID --content "更新后的回复"
suth replies delete REPLY_ID

Checklists

检查清单

Checklists are a separate subcommand, not under

cards

bash

suth checklists list -c CARD_ID              # List checklists on a card
suth checklists get CHECKLIST -c CARD_ID     # Get checklist details
suth checklists create --title "Tasks" -c CARD_ID
suth checklists update CHECKLIST --title "New Title" -c CARD_ID
suth checklists delete CHECKLIST -c CARD_ID

检查清单是独立的子命令，不属于

cards

下的命令：

bash

suth checklists list -c CARD_ID              # 列出卡片上的检查清单
suth checklists get CHECKLIST -c CARD_ID     # 获取检查清单详情
suth checklists create --title "任务项" -c CARD_ID
suth checklists update CHECKLIST --title "新标题" -c CARD_ID
suth checklists delete CHECKLIST -c CARD_ID

Items

检查项

suth checklists add-item CHECKLIST --title "Do thing" -c CARD_ID [--checked] suth checklists update-item ITEM_ID --checklist CL -c CARD_ID --title "New" suth checklists remove-item ITEM_ID --checklist CL -c CARD_ID suth checklists check ITEM_ID --checklist CL -c CARD_ID suth checklists uncheck ITEM_ID --checklist CL -c CARD_ID

undefined

suth checklists add-item CHECKLIST --title "待办事项" -c CARD_ID [--checked] suth checklists update-item ITEM_ID --checklist CL -c CARD_ID --title "新标题" suth checklists remove-item ITEM_ID --checklist CL -c CARD_ID suth checklists check ITEM_ID --checklist CL -c CARD_ID suth checklists uncheck ITEM_ID --checklist CL -c CARD_ID

undefined

Lists

列

Board list (column) management as a separate subcommand:

bash

suth lists list -b BOARD                     # List columns on board
suth lists get LIST_ID                       # Get list details
suth lists create --title "In Progress" -b BOARD
suth lists update LIST_ID --title "Done"
suth lists delete LIST_ID

看板列管理是独立的子命令：

bash

suth lists list -b BOARD                     # 列出看板上的列
suth lists get LIST_ID                       # 获取列详情
suth lists create --title "进行中" -b BOARD
suth lists update LIST_ID --title "已完成"
suth lists delete LIST_ID

Notes

笔记

bash

suth notes list                               # List notes
suth notes get NOTE_ID [-o]                   # Get note details
suth notes create --title "Meeting" [--transcript "..."]
suth notes delete NOTE_ID

bash

suth notes list                               # 列出笔记
suth notes get NOTE_ID [-o]                   # 获取笔记详情
suth notes create --title "会议记录" [--transcript "..."]
suth notes delete NOTE_ID

Sprints

迭代

bash

suth sprints list -s SPACE                    # List sprints in space
suth sprints get SPRINT_ID -s SPACE           # Get sprint details

bash

suth sprints list -s SPACE                    # 列出空间内的迭代
suth sprints get SPRINT_ID -s SPACE           # 获取迭代详情

Search

搜索

bash

suth search query "term"                      # Search workspace
suth search query "bug" --types card,page     # Filter by type
suth search query "auth" -s SPACE [--grouped] # Filter by space

bash

suth search query "关键词"                      # 搜索工作区
suth search query "bug" --types card,page     # 按类型筛选
suth search query "auth" -s SPACE [--grouped] # 按空间筛选

Config

配置

bash

suth config init                              # Create default config file
suth config show                              # Show current configuration
suth config set KEY VALUE                     # Set a config value
suth config path                              # Show config file path

bash

suth config init                              # 创建默认配置文件
suth config show                              # 显示当前配置
suth config set KEY VALUE                     # 设置配置值
suth config path                              # 显示配置文件路径

Activity

活动

bash

suth activity                                 # Show recent activity across workspace

bash

suth activity                                 # 显示工作区内的近期活动

Discovery

命令发现

bash

suth tree                                     # Print tree of all available commands

bash

suth tree                                     # 打印所有可用命令的树形结构

Shell Completion

Shell补全

bash

suth completion bash                          # Generate bash completion script
suth completion zsh                           # Generate zsh completion script
suth completion fish                          # Generate fish completion script

bash

suth completion bash                          # 生成bash补全脚本
suth completion zsh                           # 生成zsh补全脚本
suth completion fish                          # 生成fish补全脚本

Option Aliases

选项别名

Long	Short	Description
`--space`	`-s`	Space (ID or name)
`--board`	`-b`	Board (ID or name)
`--list`	`-l`	List (ID or name)
`--card`	`-c`	Card ID
`--related`	`-r`	Related card ID
`--owner`	`-o`	Owner (user ID, name, or email)
`--open`	`-o`	Open in browser (on get commands)
`--yes`	`-y`	Skip confirmation prompts

长选项	短选项	说明
`--space`	`-s`	空间（ID或名称）
`--board`	`-b`	看板（ID或名称）
`--list`	`-l`	列（ID或名称）
`--card`	`-c`	卡片ID
`--related`	`-r`	关联卡片ID
`--owner`	`-o`	所有者（用户ID、名称或邮箱）
`--open`	`-o`	在浏览器中打开（适用于get命令）
`--yes`	`-y`	跳过确认提示

Tips

提示

Most commands accept names or IDs for spaces, boards, lists, users, and tags
Use
```
-s SPACE
```
to help resolve ambiguous board/list names
Use
```
--json
```
for scripted output:
```
suth cards assigned me --json
```
Use
```
me
```
as a user reference:
```
suth cards assigned me
```
Use
```
-o
```
to open any resource in your browser:
```
suth cards get CARD -o
```
Use
```
-y
```
to skip confirmation prompts (for scripts/agents)
Priority levels: 1=Urgent, 2=High, 3=Medium, 4=Low

大多数命令接受空间、看板、列、用户和标签的名称或ID
使用
```
-s SPACE
```
来帮助解析模糊的看板/列名称
使用
```
--json
```
获取适合脚本的输出：
```
suth cards assigned me --json
```
使用
```
me
```
作为用户引用：
```
suth cards assigned me
```
使用
```
-o
```
在浏览器中打开任意资源：
```
suth cards get CARD -o
```
使用
```
-y
```
跳过确认提示（适用于脚本/Agent）
优先级等级：1=紧急，2=高，3=中，4=低

superthread

Original

Translation

Superthread CLI

Superthread CLI

Installation

安装

Setup

设置

Global Options

全局选项

Command Reference

命令参考

Accounts

账户

Workspaces

工作区

Current User & Members

当前用户与成员

Spaces

空间

Boards

看板

List (column) management

列管理

Cards

卡片

Members

成员管理

Relationships

关联关系

Tags

标签

Projects (Epics)

项目（史诗）

Pages

页面

Comments

评论

Replies

回复

Checklists

检查清单

Items

检查项

Lists

列

Notes

笔记

Sprints

迭代

Search

搜索

Tags

标签

Config

配置

Activity

活动

Discovery

命令发现

Shell Completion

Shell补全

Option Aliases

选项别名

Tips

提示