codescan

分类: 开发与编程 | 上传者: HeJiguang | 下载: 0 | 版本: v1.0（最新）

- `技能/代码扫描审查`

更新日志: Source: GitHub https://github.com/HeJiguang/codescan

目录结构

当前层级: tree/main/docs/

📁 assets/
- 📄 codex-workflow.svg 4.6 KB
- 📄 readme-hero.svg 4.4 KB
- 📄 sample-findings.svg 3.5 KB
📄 CODE_OF_CONDUCT.md 2.2 KB
📄 codex.md 2.5 KB
📄 CONTRIBUTING.md 3.0 KB
📄 example-output.md 1.3 KB
📄 good-first-issues.md 2.1 KB
📄 mcp.md 2.3 KB
📄 README.md 1.0 KB
📄 rule_server_api.md 11.2 KB
📄 rules_guide.md 6.9 KB
📄 skill.md 1.3 KB
📄 technical_doc.md 5.3 KB

SKILL.md

# CodeScan Skill Guide

## Overview

CodeScan now ships an installable skill inside this repository:

- `skills/codescan-review`

The skill does not replace the MCP server. It complements it.

- The MCP server exposes structured scan tools.
- The skill tells Codex when to use those tools and how to present the findings.

## Install From GitHub

Use Codex's GitHub skill installer with this repo path:

```bash
install-skill-from-github.py --repo HeJiguang/codescan --path skills/codescan-review
```

You can also install from the direct GitHub URL:

```bash
install-skill-from-github.py --url https://github.com/HeJiguang/codescan/tree/main/skills/codescan-review
```

After installing the skill, restart Codex so it picks up the new skill.

## What The Skill Does

The skill teaches Codex to:

- prefer CodeScan MCP tools when available
- choose the right scan scope for the task
- treat `scan_git_diff` as the default for active branch review
- report findings first, ordered by severity
- separate strong findings from weaker suspicions

## Recommended Setup

For the best experience, use both:

1. Install the `codescan-review` skill
2. Run the CodeScan MCP server with `codescan-mcp --transport stdio`

That gives Codex both:

- a reusable workflow
- a real callable security-scanning tool surface

登录后下载/点赞/收藏 ❤ 7 | ★ 0

codescan

目录结构

SKILL.md

举报内容

提示