bex-hooks

bex-hooks is a configuration-driven entrypoint for bex that loads a workflow definition from a YAML file, resolves configured plugins, and executes hooks in order within an isolated environment bootstrapped by bex.

Content

• Usage
• CLI
  • Global Options
  • Commands
• Configuration
  • config
  • hooks

Usage

bex-hooks is available on PyPI and is used as a bex entrypoint.

1. Add bex-hooks to the bootstrap header

In your workflow file, include bex-hooks in requirements and set the entrypoint:

# /// bootstrap
# requires-python: ">=3.11,<3.12"
# requirements: |
#   bex-hooks
#   bex-hooks-files
#   bex-hooks-python
# entrypoint: bex_hooks.exec:main
# ///

2. Configure plugins and hooks

Below the header, configure which plugins to load and which hooks to run:

config:
  plugins:
    - bex_hooks.hooks.python
    - bex_hooks.hooks.files

hooks:
  - id: files/download
    source: https://example.com/file.bin
    source_hash: md5:abc123...
    target: ./bin/file.bin

  - id: python/setup-python
    version: "3.12.8"
    requirements: |
      requests>=2,<3

CLI

This entrypoint exposes a CLI.

Global Options

The following options are defined by the entrypoint. They are set internally by the bootstrapper (via environment variables) and are not intended for manual use.

Commands

Command arguments for run support templating using metadata produced by the entrypoint:

bex exec run -- echo "{working_dir}"

Configuration

The entrypoint expects the following YAML structure:

config:
  plugins:
    - some.plugin.module

hooks:
  - id: some/hook
    if: some_condition
    # hook-specific fields...

config

General entrypoint configuration.

hooks

Ordered list of hook definitions. Each hook entry has the following structure: