Files
reverse-skills-max/vendor-new/analyst-ai-pack/templates/skill-template/references/api-reference.md

42 lines
921 B
Markdown

# API Reference: <Skill Title>
## Overview
[One paragraph: what `scripts/analyst.py` automates and how it fits the skill workflow.]
## Dependencies
| Package | Version | Purpose |
|---------|---------|---------|
| (stdlib) | — | Hashing, JSON, paths |
| [pkg] | >= x.y | [why] |
## External tools
| Tool | Purpose |
|------|---------|
| [tool] | [what it provides] |
## Core functions
### `analyze(target)`
[What it does, what it returns.]
### `compute_hashes(filepath)`
Returns `md5`, `sha1`, `sha256`, and `size` for file identification.
## Usage
```bash
python scripts/analyst.py path/to/artifact --json
```
## Sources
This skill was synthesized from the following primary sources. List the specific pages,
docs, specs, or reports used — not generic homepages. (See CONTRIBUTING.md.)
- [Source title — URL]
- [Source title — URL]
- [Source title — URL]