hello-auditkit

Audit/review/validate AI assistant configurations with file-only reports.

---

📑 Table of Contents

Click to expand

• 🎯 Why hello-auditkit?
• ✨ Features
• 🚀 Quick Start
• 🔧 How It Works
• 📖 Documentation
• ❓ FAQ
• 🛠️ Troubleshooting
• 📈 Version
• 🔒 Security
• 🤝 Contributing
• 📜 License

🎯 Why hello-auditkit?

This is a Codex Skill repo. It gives your coding assistant a repeatable workflow instead of one-off prompts.

Challenge	Without this skill	With this skill
Getting started	You re-explain context every time	The workflow is encoded in SKILL.md
Output quality	Inconsistent formatting	Consistent outputs + guardrails
Scope control	Easy to drift	Clear stop/confirm gates
Reuse	Hard to share	Share it as a skill folder
Speed	Manual, repetitive steps	Short prompts trigger full workflows

💡 Best for

• ✅ You want a stable workflow in Codex/Claude/Gemini CLI skills.
• ✅ You want consistent deliverables (tables/diagrams/docs/reports).
• ✅ You prefer “ask for inputs first, then generate”.

⚠️ Not for

• ❌ One-off work where you do not want workflow constraints.
• ❌ Scenarios that require silent assumptions (these skills avoid guessing).

✨ Features

🧭 Type-aware audits Knows what it is auditing. prompts / skills / plugins / memories evidence + line references no guessing Your benefit: Actionable findings.	🛡️ Safe by default Keeps scope tight. audits only what you provide no changes without confirmation minimal terminal output Your benefit: More control.
📚 Rule-driven Uses checklists and registries. structured criteria repeatable results consistent formatting Your benefit: Stable quality.	📦 File-only reports Writes reports to files. better for long audits keeps terminal clean easy to share Your benefit: Easy review.

📌 Triggers (keywords)

• 审计"、"审查"、"验证"、"检查质量"、"分析提示词"、"评估技能"、

🚀 Quick Start

Install

1. Put this folder into your Codex skills directory:

Windows: %USERPROFILE%\.codex\skills\hello-auditkit
macOS/Linux: ~/.codex/skills/hello-auditkit

2. Restart your CLI tool (if needed) so it reloads skills.
3. In chat, mention hello-auditkit or use a trigger keyword.

First run

1. Say: audit this SKILL.md (or provide a path).

2. It writes the audit report to a file.

3. Review, then decide whether to apply fixes.

🔧 How It Works

📊 Click to view the workflow

flowchart TD
  A[User prompt] --> B{Trigger match}
  B -->|match| C[Load SKILL.md + references/]
  C --> D[Ask for missing inputs]
  D --> E[Generate outputs]
  B -->|no match| F[Do nothing]

  style A fill:#e3f2fd
  style C fill:#fff3e0
  style E fill:#4caf50,color:#fff
  style F fill:#ffebee

Loading

📖 Documentation

• Start here: SKILL.md
• If present: references/ and assets/ (loaded on-demand)

❓ FAQ

Q: Does it modify files automatically?

A: No. It requires explicit confirmation before applying any fix.

Q: Where is the audit report?

A: It is saved to a file (terminal output stays minimal).

Q: Can I audit a folder?

A: Yes, provide a folder path and specify what to check.

Q: Does it use the web?

A: It may fetch the latest prompting guidelines if needed.

Q: What if the target is unclear?

A: It will ask 1–3 clarification questions.

Q: Can I limit the scope?

A: Yes, tell it exactly which files or checks to run.

🛠️ Troubleshooting

Report file not created

Problem: You did not provide a valid path/target.

Fix: Provide a concrete file/folder path and retry.

---

It asks too many questions

Problem: The audit goal is ambiguous.

Fix: Reply with the exact target and desired depth.

---

Line numbers look off

Problem: The target file changed after reading.

Fix: Re-run after saving the latest file.

---

Web fetch blocked

Problem: Network access is unavailable.

Fix: Run offline mode or enable network.

---

Output too verbose

Problem: Host tool settings may differ.

Fix: Ask it to keep terminal output minimal and write to files.

📈 Version

• Current version: 2.0.0 (see SKILL.md)

🔒 Security

• Do not paste secrets/tokens into prompts or sample files.
• If you find a security issue, open a minimal report without sensitive details.

🤝 Contributing

See CONTRIBUTING.md.

📜 License

This repository is licensed under MIT. See LICENSE.

📊 Project Stats

Made by hellowind777