Filesystem Tools

from hud.tools.filesystem import ReadTool

reader = ReadTool(base_path="./workspace")

# Read entire file
result = await reader(filePath="/path/to/file.py")

# Read with offset (0-based line number)
result = await reader(filePath="/path/to/file.py", offset=100)

# Read with limit
result = await reader(filePath="/path/to/file.py", offset=0, limit=50)

<file>
00001| def hello():
00002|     print("Hello")
00003|

(End of file - total 3 lines)
</file>

from hud.tools.filesystem import GeminiReadTool

reader = GeminiReadTool(base_path="./workspace")

# Read file
result = await reader(file_path="/path/to/file.py")

# With pagination
result = await reader(file_path="/path/to/file.py", offset=10, limit=50)

IMPORTANT: The file content has been truncated.
Status: Showing lines 11-60 of 200 total lines.
Action: To read more, use 'offset' and 'limit' parameters. Example: offset: 60.

--- FILE CONTENT (truncated) ---
def process():
    ...

from hud.tools.filesystem import GrepTool

grep = GrepTool(base_path="./workspace")

# Simple search
result = await grep(pattern="def main")

# With file filter
result = await grep(pattern="TODO|FIXME", include="*.py")

# In specific directory
result = await grep(pattern="import", path="src/")

Found 5 matches

src/main.py:
  Line 10: def main():
  Line 25: if __name__ == "__main__":

src/utils.py:
  Line 5: def helper():

from hud.tools.filesystem import GeminiSearchTool

search = GeminiSearchTool(base_path="./workspace")

# Search
result = await search(pattern="function.*async")

# With directory filter
result = await search(pattern="TODO", dir_path="src/", include="*.ts")

Found 3 matches in 2 files

src/api.ts:
  Line 15: async function fetchData() {
  Line 42: async function postData() {

src/utils.ts:
  Line 8: async function delay() {

from hud.tools.filesystem import GlobTool

glob = GlobTool(base_path="./workspace")

# Find all Python files
result = await glob(pattern="**/*.py")

# In subdirectory
result = await glob(pattern="*.ts", path="src/")

src/main.py
src/utils.py
tests/test_main.py

(Results are truncated. Consider using a more specific path or pattern.)

from hud.tools.filesystem import GeminiGlobTool

glob = GeminiGlobTool(base_path="./workspace")

# Find files
result = await glob(pattern="**/*.py")

# With options
result = await glob(
    pattern="**/*.py",
    dir_path="src/",
    case_sensitive=True,
    respect_git_ignore=True,
)

/workspace/src/main.py
/workspace/src/utils.py
/workspace/tests/test_main.py

from hud.tools.filesystem import ListTool

ls = ListTool(base_path="./workspace")

# List current directory
result = await ls()

# List specific directory
result = await ls(path="/path/to/dir")

# With ignore patterns
result = await ls(path="/path/to/dir", ignore=["*.log", "node_modules/"])

/workspace/
  src/
    main.py
    utils.py
  tests/
    test_main.py
  README.md

from hud.tools.filesystem import GeminiListTool

ls = GeminiListTool(base_path="./workspace")

# List directory
result = await ls(dir_path="/path/to/dir")

# With ignore patterns
result = await ls(dir_path="/path/to/dir", ignore=["*.pyc"])

DIR  src
DIR  tests
     README.md
     setup.py

from hud import Environment
from hud.tools import BashTool, EditTool
from hud.tools.filesystem import ReadTool, GrepTool, GlobTool, ListTool

env = Environment("coding-env")
env.add_tool(BashTool())
env.add_tool(EditTool())
env.add_tool(ReadTool())
env.add_tool(GrepTool())
env.add_tool(GlobTool())
env.add_tool(ListTool())

from hud import Environment
from hud.tools.coding import GeminiShellTool, GeminiEditTool
from hud.tools.filesystem import (
    GeminiReadTool,
    GeminiSearchTool,
    GeminiGlobTool,
    GeminiListTool,
)

env = Environment("gemini-env")
env.add_tool(GeminiShellTool())
env.add_tool(GeminiEditTool())
env.add_tool(GeminiReadTool())
env.add_tool(GeminiSearchTool())
env.add_tool(GeminiGlobTool())
env.add_tool(GeminiListTool())

from hud.tools.filesystem import ReadTool
from hud.tools.types import ToolError

reader = ReadTool()

@reader.before
async def block_sensitive(filePath: str = "", **kwargs):
    if ".env" in filePath or "secrets" in filePath.lower():
        raise ToolError("Access to sensitive files is blocked")

env.add_tool(reader)

from hud.tools.filesystem import GrepTool
from mcp.types import TextContent

class LimitedGrepTool(GrepTool):
    def __init__(self):
        super().__init__(max_results=20)  # Limit to 20 matches