docs-security-scan

Scan documentation directories for secrets and credentials in pre-commit hooks and CI pipelines.

164|44|Updated Jun 30, 2023
One-click install
npx skills add https://github.com/hivemq/hivemq-edge --skill docs-security-scan
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-security-scan
Source: https://github.com/hivemq/hivemq-edge/tree/main/hivemq-edge-frontend/.claude/skills/docs-security-scan
Command: npx skills add https://github.com/hivemq/hivemq-edge --skill docs-security-scan

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automatically detects and blocks secrets, credentials, and sensitive data accidentally committed to documentation, helping teams maintain secure repos.

Core Features & Use Cases

  • Scans documentation for high-risk patterns (API keys, tokens, private keys) and medium-risk indicators.
  • Integrates with pre-commit hooks and CI pipelines to enforce security checks on docs/.
  • Supports configurable patterns via a YAML config to tailor detection for your project.

Quick Start

Run the docs security scan on your docs directory to identify and prevent secret leakage.

Frequently Asked Questions about docs-security-scan

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I prevent secrets from leaking into documentation in pre-commit hooks?

Pre-commit secret detection scans your docs directory to block API keys, tokens, and passwords before they are committed. It inspects documentation files using configurable regex patterns to enforce security checks.

Can I configure custom regex patterns for secret detection in a CI pipeline?

Yes, secret detection in CI pipelines supports configurable YAML files. You can define custom detection patterns, exceptions, and scanning behaviors to accurately identify high-risk credentials and medium-risk indicators in your docs.

What types of sensitive data does a docs security scan look for?

A docs security scan looks for high-risk patterns like API keys, tokens, and private keys, alongside medium-risk indicators of passwords and private data. It inspects documentation to prevent accidental secret leakage in your repo.

Does pre-commit secret detection work without additional dependencies?

Yes, pre-commit secret detection works without additional dependencies. It applies directly in pre-commit hooks and CI pipelines to inspect documentation, requiring only a configurable YAML file to define detection patterns.

What is the best way to scan a docs directory for accidental credential commits?

The best way to scan a docs directory for accidental credential commits is using a pre-commit hook integrated into your CI pipelines. This automatically blocks secrets and enforces security checks before documentation is pushed.