rigging-cli


Namerigging-cli JSON
Version 0.1.2 PyPI version JSON
download
home_pageNone
SummaryHook orchestration system for AI agents - All hands to the rigging!
upload_time2025-07-28 21:33:33
maintainerNone
docs_urlNone
authorBrian Morin
requires_python>=3.11
licenseMIT
keywords hooks ai automation orchestration claude-code
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # ⚓ Rigging - Hook Orchestration for AI Agents

> "All hands to the rigging!" - A sophisticated hook management system for AI agent workflows

[![Python](https://img.shields.io/badge/python-3.11%2B-blue)](https://www.python.org/)
[![PyPI version](https://badge.fury.io/py/rigging.svg)](https://badge.fury.io/py/rigging)
[![uv](https://img.shields.io/badge/uv-latest-green)](https://github.com/astral-sh/uv)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
[![CI](https://github.com/bdmorin/rigging/actions/workflows/ci.yml/badge.svg)](https://github.com/bdmorin/rigging/actions/workflows/ci.yml)

Rigging provides comprehensive management, templating, and execution handling for AI agent hooks. Like a ship's rigging that controls the sails and direction, Rigging controls and orchestrates your AI agent's behavior through a powerful workflow system.

## 🚀 Quick Start

```bash
# Install with uvx (recommended)
uvx rigging

# Install universal logging for ALL hooks (recommended!)
rigging configure install-all

# Set sail with the TUI
rigging

# Configure hooks for your project
rigging configure --scope project

# Deploy a template
rigging template install observability
```

## 🎯 Universal Hook Handler

Rigging includes a powerful universal hook handler that logs EVERY Claude Code hook to a structured directory:

```bash
# Install logging for all hooks with one command
rigging configure install-all

# Your hooks will be logged to:
./hms-hooks/
├── PreToolUse/
│   └── Bash/2025-07-28/
│       └── 20250728_133300_236408_PreToolUse_Bash.json
├── PostToolUse/
│   └── Read/2025-07-28/
├── UserPromptSubmit/2025-07-28/
├── Stop/2025-07-28/
└── PreCompact/manual/2025-07-28/
```

Each log contains:
- Complete input data from Claude Code
- Environment variables and context
- Timestamps (ISO and Unix)
- Session information
- Tool inputs/outputs
- Python version and platform details

## 🎯 Features

- **Dynamic Hook Discovery** - Automatically detects new tools and generates all valid hook combinations
- **Beautiful TUI** - Navigate with a Textual-powered interface worthy of a ship's bridge  
- **Template System** - Deploy pre-configured hook patterns with a single command
- **Workflow Engine** - Chain complex behaviors with conditional logic
- **Comprehensive Logging** - Track every hook execution in SQLite or filesystem
- **AI Integration** - Native Claude Code SDK support for intelligent workflows
- **Real-time Monitoring** - Watch hook executions as they happen

## 📚 Documentation

- [Installation Guide](docs/installation.md)
- [Hook Types & Matchers](docs/hooks.md)
- [Creating Workflows](docs/workflows.md)
- [Template Library](docs/templates.md)
- [API Reference](docs/api.md)

## 🛠️ Commands

```bash
# Core Operations
rigging configure    # Configure hooks
rigging execute      # Run as hook endpoint
rigging logs         # View execution logs

# Discovery & Generation  
rigging discover     # Find available hooks
rigging generate     # Create hook combinations
rigging update       # Check for updates

# Templates & Workflows
rigging template list      # Browse available templates
rigging template install   # Deploy a template
rigging workflow create    # Build custom workflows
```

## 🎨 Example Hook Configuration

```json
{
  "hooks": [{
    "type": "PreToolUse",
    "matcher": "Bash",
    "handler": {
      "type": "command", 
      "command": "rigging execute --workflow bash-validator"
    }
  }]
}
```

## 🔍 JSON Validation & Linting

Rigging provides built-in validation for Claude settings files and VS Code integration:

```bash
# Validate your Claude settings
rigging validate settings

# Validate a specific file
rigging validate settings ~/.claude/settings.json
```

### VS Code Integration

The project includes a JSON schema for Claude settings files. VS Code users get:
- ✅ IntelliSense/autocomplete for hook configurations
- ✅ Real-time error detection
- ✅ Hover documentation

See [docs/vscode-json-linting.md](docs/vscode-json-linting.md) for setup instructions.

## 🚢 Naval Tradition

Rigging embraces naval terminology in honor of staying organized and shipshape:

- **"All hands to the rigging!"** - Launch the TUI
- **"Run out the guns!"** - Deploy templates  
- **"Check the ship's log"** - View logs
- **"Scan the horizon"** - Discover new hooks
- **"Steady as she goes"** - Maintain current configuration

## 🤝 Contributing

We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.

## 📜 License

MIT License - see [LICENSE](LICENSE) for details.

## 🙏 Acknowledgments

Built with love for the AI development community. Special thanks to the Anthropic team for Claude Code and its powerful hook system.

---

*"A ship is safe in harbor, but that's not what ships are for." - Set sail with Rigging and explore the possibilities of AI agent orchestration.*

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "rigging-cli",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": "hooks, ai, automation, orchestration, claude-code",
    "author": "Brian Morin",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/85/48/6535d70353e78918286bf2d173928ca8b654da24c1784c89ee575cfca490/rigging_cli-0.1.2.tar.gz",
    "platform": null,
    "description": "# \u2693 Rigging - Hook Orchestration for AI Agents\n\n> \"All hands to the rigging!\" - A sophisticated hook management system for AI agent workflows\n\n[![Python](https://img.shields.io/badge/python-3.11%2B-blue)](https://www.python.org/)\n[![PyPI version](https://badge.fury.io/py/rigging.svg)](https://badge.fury.io/py/rigging)\n[![uv](https://img.shields.io/badge/uv-latest-green)](https://github.com/astral-sh/uv)\n[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)\n[![CI](https://github.com/bdmorin/rigging/actions/workflows/ci.yml/badge.svg)](https://github.com/bdmorin/rigging/actions/workflows/ci.yml)\n\nRigging provides comprehensive management, templating, and execution handling for AI agent hooks. Like a ship's rigging that controls the sails and direction, Rigging controls and orchestrates your AI agent's behavior through a powerful workflow system.\n\n## \ud83d\ude80 Quick Start\n\n```bash\n# Install with uvx (recommended)\nuvx rigging\n\n# Install universal logging for ALL hooks (recommended!)\nrigging configure install-all\n\n# Set sail with the TUI\nrigging\n\n# Configure hooks for your project\nrigging configure --scope project\n\n# Deploy a template\nrigging template install observability\n```\n\n## \ud83c\udfaf Universal Hook Handler\n\nRigging includes a powerful universal hook handler that logs EVERY Claude Code hook to a structured directory:\n\n```bash\n# Install logging for all hooks with one command\nrigging configure install-all\n\n# Your hooks will be logged to:\n./hms-hooks/\n\u251c\u2500\u2500 PreToolUse/\n\u2502   \u2514\u2500\u2500 Bash/2025-07-28/\n\u2502       \u2514\u2500\u2500 20250728_133300_236408_PreToolUse_Bash.json\n\u251c\u2500\u2500 PostToolUse/\n\u2502   \u2514\u2500\u2500 Read/2025-07-28/\n\u251c\u2500\u2500 UserPromptSubmit/2025-07-28/\n\u251c\u2500\u2500 Stop/2025-07-28/\n\u2514\u2500\u2500 PreCompact/manual/2025-07-28/\n```\n\nEach log contains:\n- Complete input data from Claude Code\n- Environment variables and context\n- Timestamps (ISO and Unix)\n- Session information\n- Tool inputs/outputs\n- Python version and platform details\n\n## \ud83c\udfaf Features\n\n- **Dynamic Hook Discovery** - Automatically detects new tools and generates all valid hook combinations\n- **Beautiful TUI** - Navigate with a Textual-powered interface worthy of a ship's bridge  \n- **Template System** - Deploy pre-configured hook patterns with a single command\n- **Workflow Engine** - Chain complex behaviors with conditional logic\n- **Comprehensive Logging** - Track every hook execution in SQLite or filesystem\n- **AI Integration** - Native Claude Code SDK support for intelligent workflows\n- **Real-time Monitoring** - Watch hook executions as they happen\n\n## \ud83d\udcda Documentation\n\n- [Installation Guide](docs/installation.md)\n- [Hook Types & Matchers](docs/hooks.md)\n- [Creating Workflows](docs/workflows.md)\n- [Template Library](docs/templates.md)\n- [API Reference](docs/api.md)\n\n## \ud83d\udee0\ufe0f Commands\n\n```bash\n# Core Operations\nrigging configure    # Configure hooks\nrigging execute      # Run as hook endpoint\nrigging logs         # View execution logs\n\n# Discovery & Generation  \nrigging discover     # Find available hooks\nrigging generate     # Create hook combinations\nrigging update       # Check for updates\n\n# Templates & Workflows\nrigging template list      # Browse available templates\nrigging template install   # Deploy a template\nrigging workflow create    # Build custom workflows\n```\n\n## \ud83c\udfa8 Example Hook Configuration\n\n```json\n{\n  \"hooks\": [{\n    \"type\": \"PreToolUse\",\n    \"matcher\": \"Bash\",\n    \"handler\": {\n      \"type\": \"command\", \n      \"command\": \"rigging execute --workflow bash-validator\"\n    }\n  }]\n}\n```\n\n## \ud83d\udd0d JSON Validation & Linting\n\nRigging provides built-in validation for Claude settings files and VS Code integration:\n\n```bash\n# Validate your Claude settings\nrigging validate settings\n\n# Validate a specific file\nrigging validate settings ~/.claude/settings.json\n```\n\n### VS Code Integration\n\nThe project includes a JSON schema for Claude settings files. VS Code users get:\n- \u2705 IntelliSense/autocomplete for hook configurations\n- \u2705 Real-time error detection\n- \u2705 Hover documentation\n\nSee [docs/vscode-json-linting.md](docs/vscode-json-linting.md) for setup instructions.\n\n## \ud83d\udea2 Naval Tradition\n\nRigging embraces naval terminology in honor of staying organized and shipshape:\n\n- **\"All hands to the rigging!\"** - Launch the TUI\n- **\"Run out the guns!\"** - Deploy templates  \n- **\"Check the ship's log\"** - View logs\n- **\"Scan the horizon\"** - Discover new hooks\n- **\"Steady as she goes\"** - Maintain current configuration\n\n## \ud83e\udd1d Contributing\n\nWe welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.\n\n## \ud83d\udcdc License\n\nMIT License - see [LICENSE](LICENSE) for details.\n\n## \ud83d\ude4f Acknowledgments\n\nBuilt with love for the AI development community. Special thanks to the Anthropic team for Claude Code and its powerful hook system.\n\n---\n\n*\"A ship is safe in harbor, but that's not what ships are for.\" - Set sail with Rigging and explore the possibilities of AI agent orchestration.*\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Hook orchestration system for AI agents - All hands to the rigging!",
    "version": "0.1.2",
    "project_urls": {
        "Documentation": "https://github.com/bdmorin/rigging-cli#readme",
        "Homepage": "https://github.com/bdmorin/rigging-cli",
        "Issues": "https://github.com/bdmorin/rigging-cli/issues",
        "Repository": "https://github.com/bdmorin/rigging-cli"
    },
    "split_keywords": [
        "hooks",
        " ai",
        " automation",
        " orchestration",
        " claude-code"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "7d0cffaf8b9379e95580e4b0a97f8048ca0d7e0b5c0e8f98a3a3625133dd1cb9",
                "md5": "5f1e6c9732cd105e5dda24d22370abef",
                "sha256": "041bf0cb8b800e13a8a693695dcbaf66dc0cfabb5126d5cee1cdd936f83c5c11"
            },
            "downloads": -1,
            "filename": "rigging_cli-0.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5f1e6c9732cd105e5dda24d22370abef",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 41561,
            "upload_time": "2025-07-28T21:33:32",
            "upload_time_iso_8601": "2025-07-28T21:33:32.110728Z",
            "url": "https://files.pythonhosted.org/packages/7d/0c/ffaf8b9379e95580e4b0a97f8048ca0d7e0b5c0e8f98a3a3625133dd1cb9/rigging_cli-0.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "85486535d70353e78918286bf2d173928ca8b654da24c1784c89ee575cfca490",
                "md5": "9f7969eef3f39d71c52a1a9c4ff63715",
                "sha256": "5edd2830c64d5b508038a755b2cb779ce84e406fac23245936a3a523330f59eb"
            },
            "downloads": -1,
            "filename": "rigging_cli-0.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "9f7969eef3f39d71c52a1a9c4ff63715",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 42127,
            "upload_time": "2025-07-28T21:33:33",
            "upload_time_iso_8601": "2025-07-28T21:33:33.760319Z",
            "url": "https://files.pythonhosted.org/packages/85/48/6535d70353e78918286bf2d173928ca8b654da24c1784c89ee575cfca490/rigging_cli-0.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-28 21:33:33",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "bdmorin",
    "github_project": "rigging-cli#readme",
    "github_not_found": true,
    "lcname": "rigging-cli"
}
        
Elapsed time: 1.72943s