Skip to content

Commit 69986ca

Browse files
authored
Merge pull request #236 from flashcatcloud/docs/cli-agent-skill
docs(cli): reflect the single consolidated flashduty agent skill
2 parents ff34332 + 6f39de7 commit 69986ca

4 files changed

Lines changed: 9 additions & 35 deletions

File tree

en/developer/cli.mdx

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -505,28 +505,15 @@ When a projected structured output exceeds its limit, the CLI keeps the selected
505505

506506
## Agent skills
507507

508-
Flashduty CLI ships with 10 agent skills that teach AI coding agents — Claude Code, Cursor, Codex, Gemini CLI, Windsurf, and 40+ others — how to operate Flashduty from your terminal.
508+
Flashduty CLI ships with a single agent skill named `flashduty` that teaches AI coding agents — Claude Code, Cursor, Codex, Gemini CLI, Windsurf, and 40+ others — how to operate Flashduty from your terminal.
509509

510-
Install skills to every detected agent on your machine in one shot:
510+
Install it to every detected agent on your machine in one shot:
511511

512512
```bash
513513
npx skills add flashcatcloud/flashduty-cli -y -g
514514
```
515515

516-
Available skills:
517-
518-
| Skill | Scope |
519-
|-------|-------|
520-
| `flashduty-shared` | Foundation: authentication, three-layer noise model, global flags, safety rules |
521-
| `flashduty-incident` | Incident lifecycle: triage, investigate, resolve, merge, snooze, reassign |
522-
| `flashduty-alert` | Alert and alert event investigation: drill down, trace, merge |
523-
| `flashduty-change` | Change event tracking and deployment frequency trends |
524-
| `flashduty-oncall` | On-call schedule queries: who is on call, shift details |
525-
| `flashduty-channel` | Channel and escalation rule lookups |
526-
| `flashduty-statuspage` | Status page management and Atlassian → Flashduty migration |
527-
| `flashduty-insight` | Analytics: MTTA/MTTR, noise reduction, notification trends |
528-
| `flashduty-admin` | Team/member lookups and audit log search |
529-
| `flashduty-template` | Notification template validation and preview |
516+
The skill uses a router-plus-reference-card structure: `SKILL.md` carries the shared conventions (authentication, global flags, safety rules) and indexes per-domain reference cards — incidents, alerts, changes, on-call and schedules, channels and escalations, status pages, insights, monitors, RUM and sourcemaps, automations, notification templates, members and teams, and more. Before running a task, the agent reads the card for that domain to get every command, flag, and workflow for it — no `--help` trial-and-error.
530517

531518
## Common workflows
532519

en/developer/overview.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Flashduty provides multiple developer tools to help you programmatically manage
1313
</Card>
1414

1515
<Card title="Command-line tool" icon="terminal" href="/en/developer/cli">
16-
Flashduty CLI for managing incidents, on-call schedules, status pages, and notification templates from your terminal — runs on macOS, Linux, and Windows with 10 built-in AI coding-agent skills.
16+
Flashduty CLI for managing incidents, on-call schedules, status pages, and notification templates from your terminal — runs on macOS, Linux, and Windows with a built-in AI coding-agent skill.
1717
</Card>
1818

1919
<Card title="Go SDK" icon="golang" href="/en/developer/go-sdk">
@@ -44,7 +44,7 @@ Visit the [API documentation](/en/openapi/introduction) for complete endpoint re
4444

4545
## Command-line tool
4646

47-
Flashduty CLI (`flashduty`) is a command-line tool for managing the incident lifecycle, querying on-call schedules, publishing status pages, and debugging notification templates from your terminal. Its commands now cover the entire Flashduty OpenAPI. It runs on macOS, Linux, and Windows, and ships with 10 agent skills so it plugs directly into AI coding agents like Claude Code, Cursor, Codex, and Gemini CLI.
47+
Flashduty CLI (`flashduty`) is a command-line tool for managing the incident lifecycle, querying on-call schedules, publishing status pages, and debugging notification templates from your terminal. Its commands now cover the entire Flashduty OpenAPI. It runs on macOS, Linux, and Windows, and ships with a built-in agent skill so it plugs directly into AI coding agents like Claude Code, Cursor, Codex, and Gemini CLI.
4848

4949
Install with one command:
5050

zh/developer/cli.mdx

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -505,28 +505,15 @@ flashduty incident list --json --fields incident_id,title,progress
505505

506506
## Agent Skills
507507

508-
Flashduty CLI 内置 10 个 Agent Skills,可让 Claude Code、Cursor、Codex、Gemini CLI、Windsurf 等 AI 编程代理通过 CLI 操作 Flashduty。
508+
Flashduty CLI 内置一个名为 `flashduty` Agent Skill,可让 Claude Code、Cursor、Codex、Gemini CLI、Windsurf 等 AI 编程代理通过 CLI 操作 Flashduty。
509509

510510
一键安装到当前机器上检测到的所有代理:
511511

512512
```bash
513513
npx skills add flashcatcloud/flashduty-cli -y -g
514514
```
515515

516-
可用技能列表:
517-
518-
| 技能 | 覆盖范围 |
519-
|------|----------|
520-
| `flashduty-shared` | 基础:认证、三层降噪模型、全局参数、安全规则 |
521-
| `flashduty-incident` | 故障生命周期:分诊、调查、解决、合并、暂停、转派 |
522-
| `flashduty-alert` | 告警与告警事件调查:下钻、追踪、合并 |
523-
| `flashduty-change` | 变更事件追踪与部署频率趋势 |
524-
| `flashduty-oncall` | 值班查询:当前值班人、排班详情 |
525-
| `flashduty-channel` | 协作空间与分派策略查询 |
526-
| `flashduty-statuspage` | 状态页管理以及从 Atlassian 迁移到 Flashduty |
527-
| `flashduty-insight` | 分析:MTTA/MTTR、降噪率、通知趋势 |
528-
| `flashduty-admin` | 团队/成员查询与审计日志搜索 |
529-
| `flashduty-template` | 通知模板验证与预览 |
516+
技能采用「路由 + 参考卡」结构:`SKILL.md` 承载认证、全局参数、安全规则等共享约定,并按领域索引参考卡——故障、告警、变更、值班与排班、协作空间与分派、状态页、洞察、监控、RUM 与 sourcemap、自动化、通知模板、成员与团队等。代理执行任务前先读取对应领域的参考卡,即可获得该领域的全部命令、参数与工作流,无需 `--help` 试探。
530517

531518
## 常见用法
532519

zh/developer/overview.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Flashduty 提供多种开发者工具,帮助您以编程方式管理故障响
1313
</Card>
1414

1515
<Card title="命令行工具" icon="terminal" href="/zh/developer/cli">
16-
Flashduty CLI,在终端中管理故障、值班、状态页和通知模板,覆盖 macOS、Linux 和 Windows,并内置 10 个 AI 编程代理技能。
16+
Flashduty CLI,在终端中管理故障、值班、状态页和通知模板,覆盖 macOS、Linux 和 Windows,并内置 AI 编程代理技能。
1717
</Card>
1818

1919
<Card title="Go SDK" icon="golang" href="/zh/developer/go-sdk">
@@ -44,7 +44,7 @@ Flashduty Open API 采用 RESTful 风格,支持通过 APP Key 进行身份验
4444

4545
## 命令行工具
4646

47-
Flashduty CLI(`flashduty`)是一款命令行工具,可在终端中完成故障生命周期管理、值班查询、状态页发布和通知模板调试。CLI 已实现对 Flashduty OpenAPI 的全量命令覆盖。支持 macOS、Linux 和 Windows,并内置 10 个 Agent Skills,可与 Claude Code、Cursor、Codex、Gemini CLI 等 AI 编程代理协同工作。
47+
Flashduty CLI(`flashduty`)是一款命令行工具,可在终端中完成故障生命周期管理、值班查询、状态页发布和通知模板调试。CLI 已实现对 Flashduty OpenAPI 的全量命令覆盖。支持 macOS、Linux 和 Windows,并内置 Agent Skill,可与 Claude Code、Cursor、Codex、Gemini CLI 等 AI 编程代理协同工作。
4848

4949
一行命令安装:
5050

0 commit comments

Comments
 (0)