Skip to main content

llm-tools-readonly-fs

Python 3.9+ MIT License

Grants LLM the ability to glob, grep, and view files within a directory.

Installation

Install this plugin in the same environment as LLM.

llm install llm-tools-readonly-fs

Usage

To use this with the LLM command-line tool:

llm --tool ReadonlyFsTools "What test cases are missing?" --tools-debug

With the LLM Python API:

import llm
from llm_tools_readonly_fs import ReadonlyFsTools

model = llm.get_model("gpt-4.1-mini")

result = model.chain(
    "What are the main classes this repository defines?",
    tools=[ReadonlyFsTools()],
).text()

Development

To set up this plugin locally, first checkout the code. Then install the dependencies and development dependencies:

cd llm-tools-readonly-fs
uv sync --dev

To add the plugin to your local LLM installation, in editable mode, run:

llm install -e .

To run the tests:

uv run pytest -v

To run linting and formatting:

uv run ruff check --fix
uv run ruff format

License

MIT License - see LICENSE for details.

Links

Metadata

Release files for llm-tools-readonly-fs 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for llm-tools-readonly-fs 0.1.0
File Size Uploaded Provenance
llm_tools_readonly_fs-0.1.0.tar.gz 4.9 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for llm-tools-readonly-fs 0.1.0
File Interpreter ABI Platform
llm_tools_readonly_fs-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 11.0 kB

Release files / llm_tools_readonly_fs-0.1.0.tar.gz

Download URL llm_tools_readonly_fs-0.1.0.tar.gz
Size 4.9 kB
Tags Source
SHA-256 checksum
How to use checksums
61a223edfa394336a46c2057598fb66578b551ceade65a98e74e9e7aa53d838e
BLAKE2b-256 checksum
How to use checksums
2752c76716164d7ffebf1f5ce74625c79d9909619fee4313b9a8fdf0569c55fd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.7.13

Release files / llm_tools_readonly_fs-0.1.0-py3-none-any.whl

Download URL llm_tools_readonly_fs-0.1.0-py3-none-any.whl
Size 6.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3a6335ddffe386716c5b7b7e1fc73f1ef6cb0c4d6a7941ee9504f111bcdb78cf
BLAKE2b-256 checksum
How to use checksums
9bd54bf13bea983347e45c9a3ffbf35e0b59c628b432e5f325d95402f117629f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.7.13

Security for llm-tools-readonly-fs 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page