Skip to main content

Python filesystem operations toolkit with CLI and MCP server for AI integrations

Project description

pathwright banner

Publish workflow PyPI version Python versions MIT license

pathwright

Pathwright is a Python filesystem operations toolkit with two entry points:

  • CLI for terminal workflows
  • MCP server for AI model integrations

Detailed usage reference: docs/REFERENCE.md

Installation

uv sync --all-groups

CLI

Run with:

uv run pathwright --help

Supported command groups:

  • create-files, read-files, update-files, delete-files
  • search-files, transfer-files
  • create-dirs, read-dirs, update-dirs, delete-dirs
  • search-dirs, transfer-dirs
  • fs-outline, files-outline

Examples:

uv run pathwright create-files --item "tmp/a.txt::hello"
uv run pathwright read-files --path "tmp/a.txt"
uv run pathwright update-files --item "tmp/a.txt::patched\n" --interval "tmp/a.txt::2:4"
uv run pathwright search-files --base-path . --extension py --name-pattern "*.py"
uv run pathwright fs-outline --base-path . --depth 2

MCP Server

Run with:

uv run pathwright-mcp

VS Code workspace MCP config example (.vscode/mcp.json):

{
	"servers": {
		"pathwright": {
			"type": "stdio",
			"command": "uvx",
			"args": ["--from", "pathwright", "pathwright-mcp"]
		}
	}
}

For local testing from the current workspace (after uv sync --all-groups):

{
	"servers": {
		"pathwrightLocal": {
			"type": "stdio",
			"command": "uv",
			"args": ["run", "pathwright-mcp"],
			"cwd": "${workspaceFolder}"
		}
	}
}

Exposed tools map to the same filesystem operations as CLI:

  • create_files, read_files, update_files, delete_files
  • search_files, copy_or_move_files
  • create_directories, read_directories, update_directories, delete_directories
  • search_directories, copy_or_move_directories
  • filesystem_outline, files_outline

Testing

Run feature-organized end-to-end suites:

uv run pytest --maxfail=1 --tb=short

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pathwright-0.2.0.tar.gz (12.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pathwright-0.2.0-py3-none-any.whl (17.5 kB view details)

Uploaded Python 3

File details

Details for the file pathwright-0.2.0.tar.gz.

File metadata

  • Download URL: pathwright-0.2.0.tar.gz
  • Upload date:
  • Size: 12.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pathwright-0.2.0.tar.gz
Algorithm Hash digest
SHA256 15af5fc591913e41f59c33794fdf01ba255d9f569e73942cbb097f258bdf2365
MD5 e2b2a9f6c9f8165c45137ec6c14208ca
BLAKE2b-256 a048eb23cc129f2059618535cd3f6a872d38a0b7e39bfa2e8f9bae3b14c766ec

See more details on using hashes here.

Provenance

The following attestation bundles were made for pathwright-0.2.0.tar.gz:

Publisher: publish-to-pypi.yml on l0kifs/pathwright

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pathwright-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: pathwright-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 17.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pathwright-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b82cebeef6af08d745e356c3e589f4b9aa5f79ff47334919e76ad91819a46900
MD5 4d6df57561c35396de57795c908ace6b
BLAKE2b-256 e3aa88398b3bac7770ffffd8d05605f7ddd01d5a80f095f431ec5725d80290d5

See more details on using hashes here.

Provenance

The following attestation bundles were made for pathwright-0.2.0-py3-none-any.whl:

Publisher: publish-to-pypi.yml on l0kifs/pathwright

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page