pllan hooks

Manage agent hooks (event-driven automations for commands like /new, /reset, and gateway startup). Related:

List All Hooks

pllan hooks list
List all discovered hooks from workspace, managed, and bundled directories. Options:
  • --eligible: Show only eligible hooks (requirements met)
  • --json: Output as JSON
  • -v, --verbose: Show detailed information including missing requirements
Example output:
Hooks (4/4 ready)

Ready:
  🚀 boot-md ✓ - Run BOOT.md on gateway startup
  📎 bootstrap-extra-files ✓ - Inject extra workspace bootstrap files during agent bootstrap
  📝 command-logger ✓ - Log all command events to a centralized audit file
  💾 session-memory ✓ - Save session context to memory when /new command is issued
Example (verbose):
pllan hooks list --verbose
Shows missing requirements for ineligible hooks. Example (JSON):
pllan hooks list --json
Returns structured JSON for programmatic use.

Get Hook Information

pllan hooks info <name>
Show detailed information about a specific hook. Arguments:
  • <name>: Hook name (e.g., session-memory)
Options:
  • --json: Output as JSON
Example:
pllan hooks info session-memory
Output:
💾 session-memory ✓ Ready

Save session context to memory when /new command is issued

Details:
  Source: pllan-bundled
  Path: /path/to/pllan/hooks/bundled/session-memory/HOOK.md
  Handler: /path/to/pllan/hooks/bundled/session-memory/handler.ts
  Homepage: https://docs.pllan.ai/automation/hooks#session-memory
  Events: command:new

Requirements:
  Config: ✓ workspace.dir

Check Hooks Eligibility

pllan hooks check
Show summary of hook eligibility status (how many are ready vs. not ready). Options:
  • --json: Output as JSON
Example output:
Hooks Status

Total hooks: 4
Ready: 4
Not ready: 0

Enable a Hook

pllan hooks enable <name>
Enable a specific hook by adding it to your config (~/.pllan/config.json). Note: Hooks managed by plugins show plugin:<id> in pllan hooks list and can’t be enabled/disabled here. Enable/disable the plugin instead. Arguments:
  • <name>: Hook name (e.g., session-memory)
Example:
pllan hooks enable session-memory
Output:
✓ Enabled hook: 💾 session-memory
What it does:
  • Checks if hook exists and is eligible
  • Updates hooks.internal.entries.<name>.enabled = true in your config
  • Saves config to disk
After enabling:
  • Restart the gateway so hooks reload (menu bar app restart on macOS, or restart your gateway process in dev).

Disable a Hook

pllan hooks disable <name>
Disable a specific hook by updating your config. Arguments:
  • <name>: Hook name (e.g., command-logger)
Example:
pllan hooks disable command-logger
Output:
⏸ Disabled hook: 📝 command-logger
After disabling:
  • Restart the gateway so hooks reload

Install Hooks

pllan hooks install <path-or-spec>
pllan hooks install <npm-spec> --pin
Install a hook pack from a local folder/archive or npm. Npm specs are registry-only (package name + optional exact version or dist-tag). Git/URL/file specs and semver ranges are rejected. Dependency installs run with --ignore-scripts for safety. Bare specs and @latest stay on the stable track. If npm resolves either of those to a prerelease, Pllan stops and asks you to opt in explicitly with a prerelease tag such as @beta/@rc or an exact prerelease version. What it does:
  • Copies the hook pack into ~/.pllan/hooks/<id>
  • Enables the installed hooks in hooks.internal.entries.*
  • Records the install under hooks.internal.installs
Options:
  • -l, --link: Link a local directory instead of copying (adds it to hooks.internal.load.extraDirs)
  • --pin: Record npm installs as exact resolved name@version in hooks.internal.installs
Supported archives: .zip, .tgz, .tar.gz, .tar Examples:
# Local directory
pllan hooks install ./my-hook-pack

# Local archive
pllan hooks install ./my-hook-pack.zip

# NPM package
pllan hooks install @pllan/my-hook-pack

# Link a local directory without copying
pllan hooks install -l ./my-hook-pack

Update Hooks

pllan hooks update <id>
pllan hooks update --all
Update installed hook packs (npm installs only). Options:
  • --all: Update all tracked hook packs
  • --dry-run: Show what would change without writing
When a stored integrity hash exists and the fetched artifact hash changes, Pllan prints a warning and asks for confirmation before proceeding. Use global --yes to bypass prompts in CI/non-interactive runs.

Bundled Hooks

session-memory

Saves session context to memory when you issue /new. Enable:
pllan hooks enable session-memory
Output: ~/.pllan/workspace/memory/YYYY-MM-DD-slug.md See: session-memory documentation

bootstrap-extra-files

Injects additional bootstrap files (for example monorepo-local AGENTS.md / TOOLS.md) during agent:bootstrap. Enable:
pllan hooks enable bootstrap-extra-files
See: bootstrap-extra-files documentation

command-logger

Logs all command events to a centralized audit file. Enable:
pllan hooks enable command-logger
Output: ~/.pllan/logs/commands.log View logs:
# Recent commands
tail -n 20 ~/.pllan/logs/commands.log

# Pretty-print
cat ~/.pllan/logs/commands.log | jq .

# Filter by action
grep '"action":"new"' ~/.pllan/logs/commands.log | jq .
See: command-logger documentation

boot-md

Runs BOOT.md when the gateway starts (after channels start). Events: gateway:startup Enable:
pllan hooks enable boot-md
See: boot-md documentation