can1357--oh-my-pi/docs/tools/glob.md

glob

Find filesystem paths by glob; use grep when you need content matches instead of path matches.

Source

• Entry: packages/coding-agent/src/tools/glob.ts
• Model-facing prompt: packages/coding-agent/src/prompts/tools/glob.md
• Key collaborators:
  • packages/coding-agent/src/tools/path-utils.ts — normalize inputs; split base path vs glob.
  • packages/coding-agent/src/tools/list-limit.ts — apply result-count caps.
  • packages/coding-agent/src/session/streaming-output.ts — truncate text output at byte cap.
  • packages/coding-agent/src/tools/tool-result.ts — build content and details.meta.
  • packages/coding-agent/src/tools/output-meta.ts — encode limit / truncation metadata.
  • packages/coding-agent/src/tools/tool-errors.ts — map user-facing tool errors.
  • packages/coding-agent/src/tools/index.ts — register the built-in local implementation.

Inputs

Field	Type	Required	Description
paths	string[]	Yes	One or more globs, files, directories, or internal URLs with backing files. Empty strings are rejected. Single entries accidentally joined with comma, semicolon, or whitespace are expanded only after existence validation; existing paths containing delimiters stay intact. Each entry becomes its own walk root; multi-entry calls run those scans concurrently.
hidden	boolean	No	Whether hidden files are included. Defaults to true (hidden ?? true).
gitignore	boolean	No	Whether .gitignore is respected during local native globbing. Defaults to true; set false to include gitignored files.
limit	number	No	Max returned paths. Defaults to 200; finite positive inputs are floored then clamped to 1..200.

Outputs

The tool returns a single text block plus structured details.

• Success text: matching paths grouped as a multi-level, prefix-folded directory tree (formatGroupedPaths()): one # per nesting level, single-child directory chains fold into one header (# a/b/c/), and files are listed bare under the deepest owning header; root-level matches are listed without a header. Directory matches carry a trailing /. Exact file inputs return that file path as one line.
• Empty result text: No files found matching pattern, optionally followed by a timeout or missing-path notice.
• Multi-path partial miss: appends Skipped missing paths: ... after the result block, or after the empty-result line.
• details may include:
  • scopePath: display form of the searched root or merged roots.
  • fileCount: number of paths returned after result limiting.
  • files: returned paths as an array.
  • truncated: whether result count or byte truncation occurred.
  • resultLimitReached: reached result limit.
  • missingPaths: skipped missing inputs in multi-path calls.
  • truncation / meta.limits: structured truncation and limit metadata for renderers.
• Streaming: when the runtime supplies onUpdate, the local implementation emits incremental newline-delimited text snapshots during globbing, throttled to 200 ms. Final output is grouped; streaming snapshots are not.

Flow

1. GlobTool.execute() expands delimiter-flattened local paths entries with expandDelimitedPathEntries(..., parseFindPattern) unless custom operations are injected. The splitter validates candidate parts by statting their parsed base paths, keeps existing delimiter-containing paths intact, accepts comma/semicolon splits when at least one part resolves, and accepts whitespace splits only when every part resolves.
2. The tool normalizes each resulting entry with normalizePathLikeInput() and /\\/g -> "/" (packages/coding-agent/src/tools/glob.ts). Empty normalized entries fail with `paths` must contain non-empty globs or paths.
3. For multi-path local calls, partitionExistingPaths(..., parseFindPattern) (packages/coding-agent/src/tools/path-utils.ts) stats each base path. Missing entries are skipped; if all are missing, the tool throws Path not found: .... Single missing paths still hard-fail.
4. The tool calls resolveExplicitFindPatterns() for multi-entry calls; it parses each entry into its own (basePath, globPattern, hasGlob) target so every path is walked as its own root (collapsing to a shared ancestor would scan unrelated siblings). Single-entry calls parse with parseFindPattern() directly.
5. parseFindPattern() determines (basePath, globPattern, hasGlob):
   • no glob chars (*, ?, [, {) => search that path with implicit **/*.
   • glob in the first segment => search from . and, unless the pattern already starts with **/, prefix it with **/.
   • glob later in the path => split at the first glob-bearing segment.
6. resolveToCwd() converts the base path to an absolute path under the session cwd. A resolved / is rejected with Searching from root directory '/' is not allowed.
7. limit defaults to DEFAULT_LIMIT (200), must be positive and finite, is floored, then clamped to MAX_LIMIT (200). hidden and gitignore both default to true. An internal timeout of 5 seconds (5000 ms) is built via AbortSignal.timeout(...).
8. Execution then branches:
   • Custom operations branch: if GlobToolOptions.operations.glob exists, the tool checks existence with operations.exists(), short-circuits exact-file inputs via operations.stat() when available, then calls operations.glob(globPattern, searchPath, { ignore: ["**/node_modules/**", "**/.git/**"], limit }).
   • Built-in local branch: the tool stats each target's searchPath. Exact-file inputs return immediately. Directory inputs call natives.glob() with hidden, maxResults: effectiveLimit, sortByMtime: true, gitignore: useGitignore, recursive: false (recursion comes from the **/ prefix parseFindPattern() adds), and the combined abort signal; multi-target calls run their globs concurrently.
9. In the local branch, optional onMatch callbacks convert each match to a cwd-relative display path and emit throttled progress updates.
10. After native glob returns, JS merges per-target results, deduplicates repeated display paths, and sorts the merged list by mtime descending before formatting paths.
11. buildResult() applies applyListLimit() to cap the array again at effectiveLimit, formats paths with formatGroupedPaths() (from @oh-my-pi/pi-utils), appends notices, then runs truncateHead() with maxLines: Number.MAX_SAFE_INTEGER. In practice this leaves the 50 KB byte cap in place while disabling the default 3000-line cap.
12. toolResult() packages text plus details, and records result-limit / truncation metadata for renderers.

Modes / Variants

• Exact file path: if the parsed input has no glob and the resolved path stats as a file, output is that one path.
• Directory path: if the parsed input has no glob and stats as a directory, the tool searches it with implicit **/*.
• Single glob path: one input parsed by parseFindPattern().
• Multi-path search: multiple inputs resolved by resolveExplicitFindPatterns() into per-entry targets, each walked as its own root concurrently and merged afterwards.
• Partial multi-path search with missing inputs: local multi-path calls skip missing base paths and surface them as missingPaths / Skipped missing paths: ....
• Internal URL input: supported when the internal router resolves the URL to a backing file. Internal URL globs are rejected.
• Custom delegated search: uses injected GlobOperations instead of local fs + native glob.

Side Effects

• Filesystem
  • Stats the resolved base path, and in local multi-path mode stats every candidate base path up front.
  • Does not write files.
• Subprocesses / native bindings
  • Built-in local mode calls the native @oh-my-pi/pi-natives glob implementation.
• Session state (transcript, memory, jobs, checkpoints, registries)
  • Emits structured progress updates when onUpdate is provided.
  • Adds truncation / limit metadata to the tool result.
• Background work / cancellation
  • Local globbing is cancellable through the caller abort signal plus the internal timeout.

Limits & Caps

• Default result limit: 200 (DEFAULT_LIMIT in packages/coding-agent/src/tools/glob.ts).
• Maximum result limit: 200 (MAX_LIMIT); larger inputs are clamped.
• Local glob timeout: fixed at 5000 ms.
• Output byte cap: 50 * 1024 bytes (DEFAULT_MAX_BYTES in packages/coding-agent/src/session/streaming-output.ts).
• Default generic line cap in truncateHead() is 3000, but glob overrides maxLines to Number.MAX_SAFE_INTEGER, so byte size — not line count — is the practical output truncation cap.
• Streaming update throttle: 200 ms between onUpdate emissions.
• Sort order: most recent mtime first in the built-in local branch and promised in the prompt. The tool re-sorts in JS even though native glob receives sortByMtime: true so native code can still stop early at maxResults.

Errors

• User-facing ToolErrors from GlobTool.execute() include:
  • `paths` must contain non-empty globs or paths
  • Path not found: ...
  • Searching from root directory '/' is not allowed
  • Limit must be a positive number
  • Path is not a directory: ...
  • timeout result text is glob timed out after <seconds>s; returning <N> partial matches — narrow the pattern instead of retrying blindly and is returned as a successful, truncated partial result rather than an error.
• If the caller aborts, the local branch converts AbortError into ToolAbortError.
• Non-ENOENT stat failures and other unexpected errors are rethrown.
• Empty matches are not errors; they return the no-files text result.

Notes

• Reach for glob for filename / path discovery. Reach for grep when the selection criterion is file contents or regex matches; grep takes a pattern and returns anchored content matches, while glob only returns matching paths (packages/coding-agent/src/prompts/tools/glob.md, packages/coding-agent/src/prompts/tools/grep.md).
• Bare top-level globs are made recursive. *.ts is parsed as base . plus glob **/*.ts; src/*.ts stays rooted at src with a non-recursive *.ts segment; src/**/*.ts preserves explicit recursion.
• .gitignore defaults to enabled in the built-in local branch. Use gitignore: false to disable it for native traversal.
• hidden defaults to true; hidden-file exclusion is opt-out, not opt-in.
• Multi-path missing-input tolerance applies in both branches, but only the built-in local branch surfaces missingPaths / Skipped missing paths: .... The custom-operations branch hard-fails a missing searchPath only for single-input calls; in multi-input calls a missing target silently contributes no results.
• The custom GlobOperations.glob() hook receives ignore and limit, but not the hidden flag or an explicit .gitignore toggle. A remote delegate must account for that itself if it wants parity with the local branch.
• Built-in local globbing does not force fileType: File; it can return files and directories from native glob. Directory outputs also occur through exact-path passthrough or custom delegates that return them.