You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
gpt-pilot/docs/cli
solstead ab71fdf821
Plugin API: compaction/reset hooks, bootstrap file globs, memory plugin status (#13287)
* feat: add before_compaction and before_reset plugin hooks with session context

- Pass session messages to before_compaction hook
- Add before_reset plugin hook for /new and /reset commands
- Add sessionId to plugin hook agent context

* feat: extraBootstrapFiles config with glob pattern support

Add extraBootstrapFiles to agent defaults config, allowing glob patterns
(e.g. "projects/*/TOOLS.md") to auto-load project-level bootstrap files
into agent context every turn. Missing files silently skipped.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* fix(status): show custom memory plugins as enabled, not unavailable

The status command probes memory availability using the built-in
memory-core manager. Custom memory plugins (e.g. via plugin slot)
can't be probed this way, so they incorrectly showed "unavailable".
Now they show "enabled (plugin X)" without the misleading label.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* fix: use async fs.glob and capture pre-compaction messages

- Replace globSync (node:fs) with fs.glob (node:fs/promises) to match
  codebase conventions for async file operations
- Capture session.messages BEFORE replaceMessages(limited) so
  before_compaction hook receives the full conversation history,
  not the already-truncated list

* fix: resolve lint errors from CI (oxlint strict mode)

- Add void to fire-and-forget IIFE (no-floating-promises)
- Use String() for unknown catch params in template literals
- Add curly braces to single-statement if (curly rule)

* fix: resolve remaining CI lint errors in workspace.ts

- Remove `| string` from WorkspaceBootstrapFileName union (made all
  typeof members redundant per no-redundant-type-constituents)
- Use type assertion for extra bootstrap file names
- Drop redundant await on fs.glob() AsyncIterable (await-thenable)

* fix: address Greptile review — path traversal guard + fs/promises import

- workspace.ts: use path.resolve() + traversal check in loadExtraBootstrapFiles()
- commands-core.ts: import fs from node:fs/promises, drop fs.promises prefix

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* fix: resolve symlinks before workspace boundary check

Greptile correctly identified that symlinks inside the workspace could
point to files outside it, bypassing the path prefix check. Now uses
fs.realpath() to resolve symlinks before verifying the real path stays
within the workspace boundary.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* fix: address Greptile review — hook reliability and type safety

1. before_compaction: add compactingCount field so plugins know both
   the full pre-compaction message count and the truncated count being
   fed to the compaction LLM. Clarify semantics in comment.

2. loadExtraBootstrapFiles: use path.basename() for the name field
   so "projects/quaid/TOOLS.md" maps to the known "TOOLS.md" type
   instead of an invalid WorkspaceBootstrapFileName cast.

3. before_reset: fire the hook even when no session file exists.
   Previously, short sessions without a persisted file would silently
   skip the hook. Now fires with empty messages array so plugins
   always know a reset occurred.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* fix: validate bootstrap filenames and add compaction hook timeout

- Only load extra bootstrap files whose basename matches a recognized
  workspace filename (AGENTS.md, TOOLS.md, etc.), preventing arbitrary
  files from being injected into agent context.
- Wrap before_compaction hook in a 30-second Promise.race timeout so
  misbehaving plugins cannot stall the compaction pipeline.
- Clarify hook comments: before_compaction is intentionally awaited
  (plugins need messages before they're discarded) but bounded.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* fix: make before_compaction non-blocking, add sessionFile to after_compaction

- before_compaction is now true fire-and-forget — no await, no timeout.
  Plugins that need full conversation data should persist it themselves
  and return quickly, or use after_compaction for async processing.
- after_compaction now includes sessionFile path so plugins can read
  the full JSONL transcript asynchronously. All pre-compaction messages
  are preserved on disk, eliminating the need to block compaction.
- Removes Promise.race timeout pattern that didn't actually cancel
  slow hooks (just raced past them while they continued running).

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* feat: add sessionFile to before_compaction for parallel processing

The session JSONL already has all messages on disk before compaction
starts. By providing sessionFile in before_compaction, plugins can
read and extract data in parallel with the compaction LLM call rather
than waiting for after_compaction. This is the optimal path for memory
plugins that need the full conversation history.

sessionFile is also kept on after_compaction for plugins that only
need to act after compaction completes (analytics, cleanup, etc.).

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* refactor: move bootstrap extras into bundled hook

---------

Co-authored-by: Solomon Steadman <solstead@users.noreply.github.com>
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
Co-authored-by: Clawdbot <clawdbot@alfie.local>
Co-authored-by: Peter Steinberger <steipete@gmail.com>
9 months ago
..
acp.md Docs: add nav titles across docs (#5689) 10 months ago
agent.md Docs: add nav titles across docs (#5689) 10 months ago
agents.md Docs: add nav titles across docs (#5689) 10 months ago
approvals.md Docs: add nav titles across docs (#5689) 10 months ago
browser.md Docs: add nav titles across docs (#5689) 10 months ago
channels.md Docs: add nav titles across docs (#5689) 10 months ago
config.md Docs: add nav titles across docs (#5689) 10 months ago
configure.md Docs: add nav titles across docs (#5689) 10 months ago
cron.md fix(cron): share isolated announce flow + harden cron scheduling/delivery (#11641) 10 months ago
dashboard.md Docs: add nav titles across docs (#5689) 10 months ago
devices.md Security: Prevent gateway credential exfiltration via URL override (#9179) 10 months ago
directory.md Docs: add nav titles across docs (#5689) 10 months ago
dns.md Docs: add nav titles across docs (#5689) 10 months ago
docs.md Docs: add nav titles across docs (#5689) 10 months ago
doctor.md Docs: add nav titles across docs (#5689) 10 months ago
gateway.md Security: Prevent gateway credential exfiltration via URL override (#9179) 10 months ago
health.md Docs: add nav titles across docs (#5689) 10 months ago
hooks.md Plugin API: compaction/reset hooks, bootstrap file globs, memory plugin status (#13287) 9 months ago
index.md onboard: support custom provider in non-interactive flow (#14223) 9 months ago
logs.md fix(cli): drop logs --localTime alias noise 9 months ago
memory.md docs: canonicalize docs paths and align zh navigation (#11428) 10 months ago
message.md fix(discord): support forum channel thread-create (#10062) 10 months ago
models.md Docs: add nav titles across docs (#5689) 10 months ago
node.md Docs: add nav titles across docs (#5689) 10 months ago
nodes.md Docs: add nav titles across docs (#5689) 10 months ago
onboard.md feat(zai): auto-detect endpoint + default glm-5 (#14786) 9 months ago
pairing.md docs: canonicalize docs paths and align zh navigation (#11428) 10 months ago
plugins.md CLI: add plugins uninstall command (#5985) (openclaw#6141) thanks @JustasMonkev 9 months ago
reset.md Docs: add nav titles across docs (#5689) 10 months ago
sandbox.md chore: Run `pnpm format:fix`. 10 months ago
security.md fix(security): extend audit hardening checks 9 months ago
sessions.md Docs: add nav titles across docs (#5689) 10 months ago
setup.md Docs: add nav titles across docs (#5689) 10 months ago
skills.md Docs: add nav titles across docs (#5689) 10 months ago
status.md Docs: add nav titles across docs (#5689) 10 months ago
system.md Docs: add nav titles across docs (#5689) 10 months ago
tui.md docs: canonicalize docs paths and align zh navigation (#11428) 10 months ago
uninstall.md Docs: add nav titles across docs (#5689) 10 months ago
update.md Docs: add nav titles across docs (#5689) 10 months ago
voicecall.md Docs: add nav titles across docs (#5689) 10 months ago
webhooks.md Docs: add nav titles across docs (#5689) 10 months ago