rename documented cws commands#30
Merged
innomentats merged 1 commit intomainfrom Apr 22, 2026
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Updates user-facing documentation and the bundled AI-agent skill to refer to chaitin-cli instead of cws, aiming to standardize the documented command name across the repo.
Changes:
- Added a new bundled skill at
skills/chaitin-cli/SKILL.mdand removed the oldskills/chaitin-cli-usage/SKILL.md. - Updated root README(s) to use
chaitin-cliin examples. - Updated product READMEs (X-Ray, T-Answer) to use
chaitin-cliin command examples.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| skills/chaitin-cli/SKILL.md | New skill metadata + usage guide using chaitin-cli examples. |
| skills/chaitin-cli-usage/SKILL.md | Removed old skill doc that referenced cws. |
| products/xray/README.md | Switched X-Ray command examples from cws to chaitin-cli. |
| products/tanswer/README.md | Switched T-Answer command examples from cws to chaitin-cli. |
| README.md | Updated examples/symlink guidance to use chaitin-cli. |
| README.en.md | Updated examples/symlink guidance to use chaitin-cli. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
125
to
135
| ```bash | ||
| task build | ||
| ln -s ./bin/cws ./chaitin | ||
| ln -s ./bin/chaitin-cli ./chaitin | ||
| ./chaitin | ||
| ``` | ||
|
|
||
| This is equivalent to: | ||
|
|
||
| ```bash | ||
| ./bin/cws chaitin | ||
| ./bin/chaitin-cli chaitin | ||
| ``` |
Comment on lines
7
to
+16
| | 命令 | 说明 | | ||
| |------|------| | ||
| | `cws xray asset_property` | 资产管理 | | ||
| | `cws xray audit_log` | 审计日志管理 | | ||
| | `cws xray baseline` | 基线检查管理 | | ||
| | `cws xray custom_poc` | 自定义POC管理 | | ||
| | `cws xray domain_asset` | 域名资产管理 | | ||
| | `cws xray insight` | 数据洞察 | | ||
| | `cws xray ip_asset` | 主机资产管理 | | ||
| | `cws xray plan` | 任务计划管理 | | ||
| | `cws xray project` | 工作区管理 | | ||
| | `cws xray report` | 报表管理 | | ||
| | `cws xray result` | 任务结果管理 | | ||
| | `cws xray role` | 角色管理 | | ||
| | `cws xray service_asset` | 服务资产管理 | | ||
| | `cws xray system_info` | 系统信息管理 | | ||
| | `cws xray system_service` | 系统服务管理 | | ||
| | `cws xray task_config` | 任务配置管理 | | ||
| | `cws xray template` | 策略模板管理 | | ||
| | `cws xray user` | 用户管理 | | ||
| | `cws xray vulnerability` | 漏洞资产管理 | | ||
| | `cws xray web_asset` | Web资产管理 | | ||
| | `cws xray xprocess` | XProcess任务实例管理 | | ||
| | `cws xray xprocess_lite` | XProcess精简版管理 | | ||
| | `chaitin-cli xray asset_property` | 资产管理 | | ||
| | `chaitin-cli xray audit_log` | 审计日志管理 | | ||
| | `chaitin-cli xray baseline` | 基线检查管理 | | ||
| | `chaitin-cli xray custom_poc` | 自定义POC管理 | | ||
| | `chaitin-cli xray domain_asset` | 域名资产管理 | | ||
| | `chaitin-cli xray insight` | 数据洞察 | | ||
| | `chaitin-cli xray ip_asset` | 主机资产管理 | | ||
| | `chaitin-cli xray plan` | 任务计划管理 | |
Comment on lines
+19
to
+26
| | chaitin-cli tanswer firewall check-ip-is-white | CheckIpIsWhite 检查 IP 是否在白名单中 | | ||
| | chaitin-cli tanswer firewall delete-white-list | DeleteWhiteList 响应处置 / 响应白名单：删除响应白名单 | | ||
| | chaitin-cli tanswer firewall search-white-list | SearchWhiteList 响应处置 / 响应白名单：搜索响应白名单 | | ||
| | chaitin-cli tanswer firewall update-white-list-status | UpdateWhiteListStatus 响应处置 / 响应白名单：启用或禁用响应白名单 | | ||
| | chaitin-cli tanswer rules create-block-rules | CreateBlockRules 响应处置 / 旁路阻断策略：创建旁路阻断策略 | | ||
| | chaitin-cli tanswer rules search-block-rules | SearchBlockRules 响应处置 / 旁路阻断策略：搜索旁路阻断策略 | | ||
| | chaitin-cli tanswer rules update-block-rules | UpdateBlockRules 响应处置 / 旁路阻断策略：编辑旁路阻断策略 | | ||
| | chaitin-cli tanswer rules update-block-rules-status | UpdateBlockRulesStatus 响应处置 / 旁路阻断策略：启用或禁用旁路阻断策略 | |
Comment on lines
+15
to
+26
| ```bash | ||
| # Download pre-built binary from GitHub Releases | ||
| # https://github.com/chaitin/chaitin-cli/releases | ||
|
|
||
| # Or build from source | ||
| git clone https://github.com/chaitin/chaitin-cli.git | ||
| cd chaitin-cli | ||
| go build -o chaitin-cli . | ||
|
|
||
| # Run | ||
| chaitin-cli <product> <command> [flags] | ||
| ``` |
Comment on lines
126
to
136
| ```bash | ||
| task build | ||
| ln -s ./bin/cws ./chaitin | ||
| ln -s ./bin/chaitin-cli ./chaitin | ||
| ./chaitin | ||
| ``` | ||
|
|
||
| 等价于： | ||
|
|
||
| ```bash | ||
| ./bin/cws chaitin | ||
| ./bin/chaitin-cli chaitin | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
chaitin-cliinstead ofcwschaitin-cli-usagetochaitin-cliVerification