Skip to content

File Search Protocol

Searches workspace file paths, glob patterns, and file content through the selected file-search provider.

File Search Protocol

Searches workspace file paths, glob patterns, and file content through the selected file-search provider.

FieldValue
Protocol IDaster.file-search
Version1.0.0
Compatibility range^1.0.0
Requirement helperaster.file-search.require(settings?) via the protocol module
Provider helperAvailable through Protocol.provide(...).

Settings

Effect Schema (Union) exported by the protocol module.

Operations

OperationSummaryRequestResponse
findFilesFind files and directories across workspace roots.Effect Schema (Objects)Effect Schema (Objects)
globFind files matching a glob pattern across workspace roots.Effect Schema (Objects)Effect Schema (Objects)
grepSearch file contents across workspace roots.Effect Schema (Objects)Effect Schema (Objects)

Conformance Expectations

  • Register with aster.file-search at 1.0.0 inside ^1.0.0.
  • Implement every operation: findFiles, glob, grep.
  • Decode requests and responses against the operation schemas listed above.
  • Run the protocol conformance kit where one exists: No named kit yet; providers are still expected to satisfy the registry schemas..

Declared Authority

[
{
"kind": "fs",
"access": "read",
"path": {
"kind": "parameter",
"parameter": "roots"
}
}
]