Skip to content

README.md

Latest commit

 

History

History
99 lines (72 loc) · 2.95 KB

README.md

File metadata and controls

99 lines (72 loc) · 2.95 KB
Raw
file_type documentation
title Portable Hooks & Guardrails
description Ownership index for safe portable hooks, guardrails, and tool adapters for Claude Code, GitHub, and automation platforms.
version v0.3.1
created_date 2026-05-26
last_updated 2026-05-29
maintainer LightSpeed Team
authors
LightSpeed Team
license GPL-3.0
stability stable
domain governance
tags
hooks
guardrails
ai-ops
automation
security

Portable Hooks & Guardrails

This folder contains reusable hooks, guardrails, and tool adapters designed to enhance security, logging, and safety across Claude Code, GitHub Actions, and other automation platforms.

Overview

Portable hooks are self-contained modules that can be integrated into any LightSpeed project or automation workflow. They provide:

  • Security Guardrails – Prevent accidental exposure of secrets and credentials
  • Session Logging – Track AI agent activities for auditing and debugging
  • Tool Governance – Control and validate tool usage across automation platforms
  • Safety Adapters – Bridge between platforms whilst maintaining consistent security policies

Available Hooks

Hook Status Purpose
tool-guardian active Control and validate tool usage permissions
secrets-scanner active Detect and prevent secret exposure
session-logger active Log and audit AI agent sessions

Hook Registry

See hook-registry.json for the canonical ownership index of all portable hooks, including their status, paths, and metadata.

Integration Guide

Using Hooks in Claude Code

Hooks can be configured in your project's settings.json:

{
  "hooks": {
    "before:submit": ["./hooks/secrets-scanner"],
    "after:tool": ["./hooks/tool-guardian"],
    "on:session-start": ["./hooks/session-logger"]
  }
}

Using Hooks in GitHub Actions

Reference portable hooks in your workflow files:

- name: Scan for secrets
  uses: lightspeedwp/.github/hooks/secrets-scanner@main

- name: Validate tool usage
  uses: lightspeedwp/.github/hooks/tool-guardian@main

Stability & Versioning

  • stable – Recommended for production use; breaking changes trigger major version bumps
  • experimental – May change frequently; suitable for testing and feedback
  • deprecated – No longer recommended; use alternative instead

For version migration guides, see individual hook documentation.

Contributing

To add a new hook:

  1. Create a new directory with a clear, descriptive name
  2. Include a README.md with full documentation and examples
  3. Update hook-registry.json with metadata
  4. Add tests in the hook's directory
  5. Submit a PR for review

See CONTRIBUTING.md for full contribution guidelines.

🎼 Orchestrated automation — where intelligence meets operations