Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.heylua.ai/llms.txt

Use this file to discover all available pages before exploring further.

Overview

lua preprocessors manages preprocessor primitives — code that runs before a user message reaches your agent. Use preprocessors for content filtering, routing, rate limiting, validation, and message rewriting.
lua preprocessors                            # Interactive management
lua preprocessors view                       # List all preprocessors
lua preprocessors deploy --preprocessor-name myPre --preprocessor-version 1.0.3
For defining preprocessors in code, see the Preprocessor concept and the Preprocessor API.

Subcommands

ActionWhat it does
viewList all preprocessors defined on the agent.
versionsList every version of a specific preprocessor.
deployPromote a version to active.
activateRe-enable a deactivated preprocessor.
deactivatePause execution — messages bypass this preprocessor.
deletePermanently remove a preprocessor and all its versions.

Options

OptionDescription
--preprocessor-name <name>Preprocessor name. Required for most non-interactive actions.
--preprocessor-version <ver>Version for deploy. Pass latest for the newest.
The shorthand pre resolves to preprocessor in most argument positions — e.g. lua pre view, lua logs --type pre.

Examples

# Interactive
lua preprocessors

# List everything
lua preprocessors view

# List versions
lua preprocessors versions --preprocessor-name myPre

# Promote a specific version
lua preprocessors deploy --preprocessor-name myPre --preprocessor-version 1.0.3
lua preprocessors deploy --preprocessor-name myPre --preprocessor-version latest

# Pause and resume
lua preprocessors deactivate --preprocessor-name myPre
lua preprocessors activate   --preprocessor-name myPre

# Delete
lua preprocessors delete --preprocessor-name oldPre

Common Workflow

# Edit src/preprocessors/profanity-filter.ts, then:
lua push preprocessor                                            # Build + upload
lua preprocessors versions --preprocessor-name profanityFilter   # Confirm
lua preprocessors deploy --preprocessor-name profanityFilter --preprocessor-version latest
lua logs --type preprocessor --name profanityFilter --limit 20   # Verify execution