/install asyncguard
\r \r
AsyncGuard -- Async/Await Anti-Pattern Analyzer\r
\r AsyncGuard scans codebases for async/await anti-patterns, promise misuse, async resource leaks, event loop blocking, missing cancellation support, async error handling gaps, and coordination issues. It uses regex-based pattern matching against 90 async-specific patterns across 6 categories, lefthook for git hook integration, and produces markdown reports with actionable remediation guidance. 100% local. Zero telemetry.\r \r
Commands\r
\r
Free Tier (No license required)\r
\r
asyncguard scan [file|directory]\r
One-shot async safety scan of files or directories.\r \r How to execute:\r
bash "\x3CSKILL_DIR>/scripts/dispatcher.sh" --path [target]\r
```\r
\r
**What it does:**\r
1. Accepts a file path or directory (defaults to current directory)\r
2. Discovers all source files (skips .git, node_modules, binaries, images, .min.js)\r
3. Runs 30 async patterns against each file (free tier limit)\r
4. Calculates an async safety score (0-100) per file and overall\r
5. Grades: A (90-100), B (80-89), C (70-79), D (60-69), F (\x3C60)\r
6. Outputs findings with: file, line number, check ID, severity, description, recommendation\r
7. Exit code 0 if score >= 70, exit code 1 if async quality is poor\r
8. Free tier limited to first 30 patterns (PM + AR categories)\r
\r
**Example usage scenarios:**\r
- "Scan my code for async issues" -> runs `asyncguard scan .`\r
- "Check this file for promise misuse" -> runs `asyncguard scan src/server.ts`\r
- "Find resource leaks in my async code" -> runs `asyncguard scan src/`\r
- "Audit async patterns in my project" -> runs `asyncguard scan .`\r
- "Check for missing cancellation" -> runs `asyncguard scan .`\r
\r
### Pro Tier ($19/user/month -- requires ASYNCGUARD_LICENSE_KEY)\r
\r
#### `asyncguard scan --tier pro [file|directory]`\r
Extended scan with 60 patterns covering promise misuse, resource leaks, event loop blocking, and cancellation.\r
\r
**How to execute:**\r
```bash\r
bash "\x3CSKILL_DIR>/scripts/dispatcher.sh" --path [target] --tier pro\r
```\r
\r
**What it does:**\r
1. Validates Pro+ license\r
2. Runs 60 async patterns (PM, AR, EL, CA categories)\r
3. Detects event loop blocking (sync I/O, sync crypto)\r
4. Identifies missing cancellation and abort handling\r
5. Full category breakdown reporting\r
\r
#### `asyncguard scan --format json [directory]`\r
Generate JSON output for CI/CD integration.\r
\r
```bash\r
bash "\x3CSKILL_DIR>/scripts/dispatcher.sh" --path [directory] --format json\r
```\r
\r
#### `asyncguard scan --format html [directory]`\r
Generate HTML report for browser viewing.\r
\r
```bash\r
bash "\x3CSKILL_DIR>/scripts/dispatcher.sh" --path [directory] --format html\r
```\r
\r
#### `asyncguard scan --category EL [directory]`\r
Filter scan to a specific check category (PM, AR, EL, CA, AE, AC).\r
\r
```bash\r
bash "\x3CSKILL_DIR>/scripts/dispatcher.sh" --path [directory] --category EL\r
```\r
\r
### Team Tier ($39/user/month -- requires ASYNCGUARD_LICENSE_KEY with team tier)\r
\r
#### `asyncguard scan --tier team [directory]`\r
Full scan with all 90 patterns across all 6 categories including async error patterns and coordination.\r
\r
**How to execute:**\r
```bash\r
bash "\x3CSKILL_DIR>/scripts/dispatcher.sh" --path [directory] --tier team\r
```\r
\r
**What it does:**\r
1. Validates Team+ license\r
2. Runs all 90 patterns across 6 categories\r
3. Includes async error pattern detection (swallowed rejections, async forEach, empty catch)\r
4. Includes coordination checks (unbounded concurrency, missing backpressure, no rate limit)\r
5. Full category breakdown with per-file results\r
\r
#### `asyncguard scan --verbose [directory]`\r
Verbose output showing every matched line and pattern details.\r
\r
```bash\r
bash "\x3CSKILL_DIR>/scripts/dispatcher.sh" --path [directory] --verbose\r
```\r
\r
#### `asyncguard status`\r
Show license and configuration information.\r
\r
```bash\r
bash "\x3CSKILL_DIR>/scripts/dispatcher.sh" status\r
```\r
\r
## Check Categories\r
\r
AsyncGuard detects 90 async anti-patterns across 6 categories:\r
\r
| Category | Code | Patterns | Description | Severity Range |\r
|----------|------|----------|-------------|----------------|\r
| **Promise/Future Misuse** | PM | 15 | Unhandled promises, async executor, nested .then chains, deferred antipattern | medium -- critical |\r
| **Async Resource Leaks** | AR | 15 | Unclosed connections, missing dispose, dangling streams, leaked timers | medium -- critical |\r
| **Event Loop Blocking** | EL | 15 | Sync file I/O, sync crypto, CPU loops, sync child process | low -- critical |\r
| **Cancellation & Abortion** | CA | 15 | Missing AbortSignal, orphaned tasks, no cleanup on unmount | medium -- critical |\r
| **Async Error Patterns** | AE | 15 | Swallowed rejections, empty .catch, async forEach, missing try/catch | medium -- critical |\r
| **Async Coordination** | AC | 15 | Unbounded Promise.all, missing semaphore, no backpressure, no rate limit | medium -- critical |\r
\r
## Tier-Based Pattern Access\r
\r
| Tier | Patterns | Categories |\r
|------|----------|------------|\r
| **Free** | 30 | PM, AR |\r
| **Pro** | 60 | PM, AR, EL, CA |\r
| **Team** | 90 | PM, AR, EL, CA, AE, AC |\r
| **Enterprise** | 90 | PM, AR, EL, CA, AE, AC + priority support |\r
\r
## Scoring\r
\r
AsyncGuard uses a deductive scoring system starting at 100 (perfect):\r
\r
| Severity | Point Deduction | Description |\r
|----------|-----------------|-------------|\r
| **Critical** | -25 per finding | Severe async issue (resource leaks, unhandled rejections, blocking I/O) |\r
| **High** | -15 per finding | Significant async problem (missing cancellation, no error handler) |\r
| **Medium** | -8 per finding | Moderate concern (coordination issues, missing backpressure) |\r
| **Low** | -3 per finding | Informational / best practice suggestion |\r
\r
### Grading Scale\r
\r
| Grade | Score Range | Meaning |\r
|-------|-------------|---------|\r
| **A** | 90-100 | Excellent async code quality |\r
| **B** | 80-89 | Good async patterns with minor issues |\r
| **C** | 70-79 | Acceptable but needs improvement |\r
| **D** | 60-69 | Poor async quality |\r
| **F** | Below 60 | Critical async problems |\r
\r
- **Pass threshold:** 70 (Grade C or better)\r
- Exit code 0 = pass (score >= 70)\r
- Exit code 1 = fail (score \x3C 70)\r
\r
## Configuration\r
\r
Users can configure AsyncGuard in `~/.openclaw/openclaw.json`:\r
\r
```json\r
{\r
"skills": {\r
"entries": {\r
"asyncguard": {\r
"enabled": true,\r
"apiKey": "YOUR_LICENSE_KEY_HERE",\r
"config": {\r
"severityThreshold": "medium",\r
"ignorePatterns": ["**/test/**", "**/fixtures/**", "**/*.test.*"],\r
"ignoreChecks": [],\r
"reportFormat": "text"\r
}\r
}\r
}\r
}\r
}\r
```\r
\r
## Important Notes\r
\r
- **Free tier** works immediately with no configuration\r
- **All scanning happens locally** -- no code is sent to external servers\r
- **License validation is offline** -- no phone-home or network calls\r
- Pattern matching only -- no AST parsing, no external dependencies beyond bash\r
- Supports scanning all file types in a single pass\r
- Git hooks use **lefthook** which must be installed (see install metadata above)\r
- Exit codes: 0 = pass (score >= 70), 1 = fail (for CI/CD integration)\r
- Output formats: text (default), json, html\r
\r
## Error Handling\r
\r
- If lefthook is not installed and user tries hooks, prompt to install it\r
- If license key is invalid or expired, show clear message with link to https://asyncguard.pages.dev/renew\r
- If a file is binary, skip it automatically with no warning\r
- If no scannable files found in target, report clean scan with info message\r
- If an invalid category is specified with --category, show available categories\r
\r
## When to Use AsyncGuard\r
\r
The user might say things like:\r
- "Scan my code for async issues"\r
- "Check my promise handling"\r
- "Find resource leaks in async code"\r
- "Detect event loop blocking"\r
- "Are there any missing cancellation handlers?"\r
- "Check for unhandled promise rejections"\r
- "Audit my async error handling"\r
- "Find missing AbortController usage"\r
- "Check for synchronous I/O in async functions"\r
- "Scan for async anti-patterns"\r
- "Run an async code audit"\r
- "Generate an async safety report"\r
- "Check if my fetch calls have abort signals"\r
- "Find empty catch handlers"\r
- "Check my code for async coordination issues"\r
- 确保已安装 OpenClaw(本地或 Docker 部署)
- 在对话框中输入安装命令:
/install asyncguard - 安装完成后,直接呼叫该 Skill 的名称或使用
/asyncguard触发 - 根据 Skill 的参数说明提供必要输入,即可获得结构化输出
asyncguard 是什么?
Async/await anti-pattern analyzer -- detects promise misuse, async resource leaks, event loop blocking, missing cancellation, async error patterns, and coord... 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件,目前累计下载 79 次。
如何安装 asyncguard?
在 OpenClaw 或 Claude Code 对话框中运行命令「/install asyncguard」即可一键安装,无需额外配置。
asyncguard 是免费的吗?
是的,asyncguard 完全免费,采用 MIT-0 许可证,可自由下载、安装和使用。
asyncguard 支持哪些平台?
asyncguard 跨平台运行,可在任意部署了 OpenClaw / Claude Code 的环境中使用(darwin, linux, win32)。
谁开发了 asyncguard?
由 suhteevah(@suhteevah)开发并维护,当前版本 v1.0.1。