Search_files_tools

Name: Search_files_tools
Rating: 3.5 (1 reviews)
Author: lan17

By lan17 👁 4 views ▲ 0 votes

OpenClaw plugin for searching and globbing files

GitHub

Install

npm install
openclaw

README

# Search Files Tools

<p align="center">
  <a href="https://www.npmjs.com/package/search-files-tools">
    <img src="https://img.shields.io/npm/v/search-files-tools?logo=npm" alt="npm version">
  </a>
  <a href="https://github.com/lan17/search_files_tools/blob/main/package.json">
    <img src="https://img.shields.io/badge/node-%3E%3D24-339933?logo=node.js&logoColor=white" alt="Node 24 or newer">
  </a>
  <a href="https://github.com/lan17/search_files_tools/actions/workflows/lint.yml">
    <img src="https://github.com/lan17/search_files_tools/actions/workflows/lint.yml/badge.svg" alt="CI">
  </a>
  <a href="https://app.codecov.io/gh/lan17/search_files_tools">
    <img src="https://codecov.io/gh/lan17/search_files_tools/graph/badge.svg?branch=main" alt="Codecov">
  </a>
</p>

OpenClaw plugin for searching and globbing files from agents.

## Features

- `files_search`: search file contents under an absolute root directory.
- `files_glob`: list files matching glob patterns under an absolute root directory.
- Shared root validation and OpenClaw filesystem policy enforcement.
- `rg` preferred for search, with `grep` fallback.

## Install

```bash
openclaw plugins install search-files-tools --dangerously-force-unsafe-install
```

For local development:

```bash
npm install
openclaw plugins install -l /absolute/path/to/search_files_tools --dangerously-force-unsafe-install
```

This plugin intentionally shells out to `rg` or `grep` for search execution.
OpenClaw's built-in plugin safety scanner treats `node:child_process` usage as
unsafe code, so installation requires the explicit
`--dangerously-force-unsafe-install` override.

## Configuration

The plugin exposes four operational caps under
`plugins.entries.search-files-tools.config`:

- `timeoutMs` default `20000`
- `maxCandidateFiles` default `20000`
- `maxSearchResults` default `2000`
- `maxGlobResults` default `5000`

## Tools

### `files_search`

Search files below an absolute `root` path. Search results return root-relative
POSIX paths and support structured options such as `patterns`,
`includeGlobs`, `excludeGlobs`, `ignoreCase`, `fixedStrings`, and
`beforeContext` / `afterContext`.

### `files_glob`

List files below an absolute `root` path that match one or more glob
`patterns`. Results return root-relative POSIX paths.

## Verification

```bash
npm run lint
npm run typecheck
npm test
npm run coverage
```

tools