docs: add README
This commit is contained in:
47
README.md
Normal file
47
README.md
Normal file
@@ -0,0 +1,47 @@
|
||||
# AirSDB
|
||||
|
||||
**Cppcheck static analysis for C/C++**
|
||||
|
||||
Version: 0.1.1
|
||||
Author: 14816
|
||||
License: MIT
|
||||
Repository: http://git.airlongdian.fun/admin/airsdb.git
|
||||
Homepage: https://airlongdian.fun/plugins/airsdb
|
||||
|
||||
---
|
||||
|
||||
## Description
|
||||
|
||||
AirSDB helps run cppcheck static analysis for C or C++ projects, detect or auto-configure cppcheck on first startup, run local scans using compile_commands.json when available, default to --check-level=exhaustive for maximum branch-analysis detail, run remote scans over SSH, write detailed XML or JSON artifacts, maintain concise staticanalysis.md reports, and hand evidence to AirDbg and AirDo.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
# Add the Air marketplace
|
||||
claude plugin marketplace add http://git.airlongdian.fun/admin/airplan.git
|
||||
|
||||
# Install this plugin
|
||||
claude plugin install airsdb
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
- `/airsdb - Run cppcheck and capture static-analysis evidence`
|
||||
|
||||
For detailed usage, see `commands/airsdb.md` in this repository.
|
||||
|
||||
## Requirements
|
||||
|
||||
- Claude Code CLI or desktop app (latest version recommended)
|
||||
- Python 3.8+ (for script-based plugins)
|
||||
- Additional dependencies listed in the plugin's skill documentation
|
||||
|
||||
## Part of Air Suite
|
||||
|
||||
This plugin is part of the [Air workflow suite](http://git.airlongdian.fun/admin/airplan). See the [marketplace README](http://git.airlongdian.fun/admin/airplan) for the full plugin list and installation instructions.
|
||||
|
||||
## Support
|
||||
|
||||
- Repository: http://git.airlongdian.fun/admin/airsdb.git
|
||||
- Issues: Open an issue in this repository
|
||||
- Homepage: https://airlongdian.fun/plugins/airsdb
|
||||
Reference in New Issue
Block a user