SeggWat CLI
The SeggWat CLI (seggwat) lets you manage feedback, projects, and ratings for the SeggWat feedback platform directly from the terminal.
Installation
CODEBLOCK0
A shell-based installer is also available at https://seggwat.com/static/install.sh (supports pinning a version via VERSION=v0.17.2).
Verify: INLINECODE3
Authentication
Two methods are available. Use API key for scripts/CI, OAuth for interactive use.
API Key (non-interactive, recommended for automation)
CODEBLOCK1
API keys use the oat_ prefix (Organization Access Token) and are created in the SeggWat Dashboard under Settings > API Tokens.
OAuth Login (interactive)
CODEBLOCK2
For self-hosted instances, pass --api-url, --zitadel-domain, and --client-id to point at your own deployment.
Global Options
| Flag | Env Variable | Description |
|---|
| INLINECODE8 | INLINECODE9 | API base URL (default: https://seggwat.com) |
| INLINECODE11 |
SEGGWAT_API_KEY | API key for authentication |
|
--json | — | Output as JSON instead of tables |
|
-v, --verbose | — | Enable debug logging |
Commands Reference
Projects
CODEBLOCK3
Feedback
CRUD operations:
CODEBLOCK4
Feedback statuses: new, active, assigned, hold, closed, INLINECODE20
Feedback types: bug, feature, praise, question, improvement, INLINECODE26
Aliases: feedback → fb, list → ls, delete → INLINECODE32
Ratings
CODEBLOCK5
Rating types:
- -
helpful — binary thumbs up/down (value: true/false) - INLINECODE34 — 1-5 star rating (value + max_stars)
- INLINECODE35 — Net Promoter Score 0-10 (promoters 9-10, passives 7-8, detractors 0-6)
Aliases: rating → r, list → ls, delete → INLINECODE41
Shell Completions
CODEBLOCK6
JSON Output & Scripting
Add --json to any command for machine-readable output, useful for piping to jq or other tools:
CODEBLOCK7
Common Workflows
Triage new feedback
CODEBLOCK8
Monitor rating health
CODEBLOCK9
CI/CD integration
CODEBLOCK10
SeggWat CLI
SeggWat CLI（seggwat）让您可以直接在终端中管理 SeggWat 反馈平台上的反馈、项目和评分。
安装
bash
cargo install seggwat-cli
https://seggwat.com/static/install.sh 也提供基于 Shell 的安装程序（支持通过 VERSION=v0.17.2 固定版本）。
验证：seggwat --version
身份验证
提供两种方式。脚本/CI 环境使用 API 密钥，交互式使用 OAuth。
API 密钥（非交互式，推荐用于自动化）
bash
环境变量
export SEGGWAT
APIKEY=oat_
或内联标志
seggwat --api-key oat_ project list
API 密钥使用 oat_ 前缀（组织访问令牌），可在 SeggWat 仪表盘的设置 > API 令牌中创建。
OAuth 登录（交互式）
bash
seggwat login # 打开浏览器，令牌缓存至 ~/.config/seggwat/tokens.json
seggwat whoami # 显示当前用户
seggwat logout # 清除缓存的令牌
对于自托管实例，传递 --api-url、--zitadel-domain 和 --client-id 以指向您自己的部署。
全局选项
| 标志 | 环境变量 | 描述 |
|---|
| --api-url <url> | SEGGWATAPIURL | API 基础 URL（默认：https://seggwat.com） |
| --api-key <key> |
SEGGWATAPIKEY | 用于身份验证的 API 密钥 |
| --json | — | 以 JSON 而非表格形式输出 |
| -v, --verbose | — | 启用调试日志 |
命令参考
项目
bash
seggwat project list # 列出所有项目（别名：p ls）
seggwat project get # 获取项目详情
seggwat project summary # 项目概览，包含反馈和评分统计
反馈
CRUD 操作：
bash
列出（可选过滤和分页）
seggwat feedback list [--status ] [--type ] [--search ] [--page N] [--limit N]
获取单个项目
seggwat feedback get
创建
seggwat feedback create --message text [--type bug|feature|praise|question|improvement|other] [--path /page] [--version 1.0.0]
更新
seggwat feedback update [--message text] [--type ] [--status ] [--resolution-note text]
删除（归档）
seggwat feedback delete
统计
seggwat feedback stats
反馈状态： new、active、assigned、hold、closed、resolved
反馈类型： bug、feature、praise、question、improvement、other
别名： feedback → fb、list → ls、delete → rm
评分
bash
列出（可选过滤）
seggwat rating list [--type helpful|star|nps] [--path /page] [--page N] [--limit N]
获取单个评分
seggwat rating get
删除（归档）
seggwat rating delete
统计（类型默认为 helpful）
seggwat rating stats --type helpful # 点赞/点踩百分比
seggwat rating stats --type star # 星级分布与平均值
seggwat rating stats --type nps # NPS 分数、推荐者/被动者/贬损者
评分类型：
- - helpful — 二元点赞/点踩（值：true/false）
- star — 1-5 星评分（值 + max_stars）
- nps — 净推荐值 0-10（推荐者 9-10、被动者 7-8、贬损者 0-6）
别名： rating → r、list → ls、delete → rm
Shell 补全
bash
seggwat completions bash > ~/.local/share/bash-completion/completions/seggwat
seggwat completions zsh > ~/.zfunc/_seggwat
seggwat completions fish > ~/.config/fish/completions/seggwat.fish
JSON 输出与脚本编写
为任何命令添加 --json 以获得机器可读的输出，便于通过管道传递给 jq 或其他工具：
bash
列出项目 ID
seggwat project list --json | jq -r .projects[].id
统计未解决的 Bug
seggwat feedback list PROJECT_ID --type bug --status new --json | jq .feedback | length
导出所有反馈
seggwat feedback list PROJECT_ID --limit 100 --json > feedback.json
获取 NPS 分数
seggwat rating stats PROJECT_ID --type nps --json | jq .score
查找包含关键词的反馈
seggwat feedback list PROJECT_ID --search login --json | jq .feedback[].message
常见工作流程
分类新反馈
bash
查看新内容
seggwat feedback list PROJECT_ID --status new
审核并更新状态
seggwat feedback update PROJECTID FEEDBACKID --status active
seggwat feedback update PROJECTID FEEDBACKID --status resolved --resolution-note 已在 v2.1 中修复
监控评分健康度
bash
快速健康检查
seggwat rating stats PROJECT_ID --type helpful
seggwat rating stats PROJECT_ID --type nps
检查特定页面表现
seggwat rating list PROJECT_ID --type star --path /pricing
CI/CD 集成
bash
在流水线中，从测试结果创建反馈
export SEGGWATAPIKEY=oat_
seggwat feedback create PROJECT_ID \
--message E2E 测试失败：结账流程 \
--type bug \
--version $(git describe --tags)
