fs-tool-cli 0.1.2__py3-none-any.whl

fs_tool_cli-0.1.2.dist-info/METADATA

@@ -0,0 +1,91 @@
+Metadata-Version: 2.4
+Name: fs-tool-cli
+Version: 0.1.2
+Summary: Lightweight, secure CLI for inspecting and organizing local filesystems.
+Author: pamagister
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click<8.2,>=8.1
+Requires-Dist: typer<0.13,>=0.12
+Provides-Extra: metadata
+Requires-Dist: pypdf<6,>=5; extra == "metadata"
+Dynamic: license-file
+
+# Welcome to fs-tool
+
+fs-tool is a lightweight, secure and agent-friendly command-line application for analyzing, 
+organizing and restructuring local filesystems. 
+Its primary purpose is to provide an interface for inspecting directory structures, 
+understanding file contents and metadata, identifying duplicates, comparing directory trees, 
+and performing file operations.
+
+[![Github CI Status](https://github.com/pamagister/fs-tool/actions/workflows/main.yml/badge.svg)](https://github.com/pamagister/fs-tool/actions)
+[![GitHub release](https://img.shields.io/github/v/release/pamagister/fs-tool)](https://github.com/pamagister/fs-tool/releases)
+[![Read the Docs](https://readthedocs.org/projects/fs-tool/badge/?version=stable)](https://fs-tool.readthedocs.io/en/stable/)
+[![License](https://img.shields.io/github/license/pamagister/fs-tool)](https://github.com/pamagister/fs-tool/blob/main/LICENSE)
+[![GitHub issues](https://img.shields.io/github/issues/pamagister/fs-tool)](https://github.com/pamagister/fs-tool/issues)
+[![PyPI](https://img.shields.io/pypi/v/fs-tool)](https://pypi.org/project/fs-tool-cli/)
+[![Downloads](https://pepy.tech/badge/fs-tool)](https://pepy.tech/project/fs-tool-cli/)
+
+
+## Project Vision
+
+`fs-tool` is a lightweight, secure and agent-friendly command-line application for analyzing, organizing and restructuring local filesystems.
+
+Its primary purpose is to provide a reliable interface for inspecting directory structures, understanding file contents and metadata, identifying duplicates, comparing directory trees, and performing controlled file operations.
+
+The tool should be useful both for interactive human users and for automated workflows.
+
+## Guiding Principle
+
+**The agent makes decisions; fs-tool provides the information and executes filesystem operations safely and deterministically.**
+
+The application must remain independent of any particular AI agent, MCP implementation or external automation framework.
+
+## Design Philosophy
+
+- Prefer simplicity over unnecessary abstraction.
+- Keep the Python filesystem core independent of the CLI.
+- Use structured JSON output as the primary interface.
+- Provide readable human-oriented output as an alternative.
+- Make filesystem operations predictable, transparent and verifiable.
+- Never silently overwrite or delete user data.
+- Require explicit authorization for potentially risky operations.
+- Favor deterministic results and reproducible inventories.
+- Keep dependencies minimal.
+
+## Future Agentic Workflow
+
+The long-term vision is to enable AI agents, especially OpenCode, to organize complex directory structures autonomously under controlled conditions.
+
+A typical workflow:
+
+1. Inspect and inventory the existing filesystem.
+2. Analyze filenames, metadata, file types and contents where appropriate.
+3. Identify duplicates, inconsistencies and organizational opportunities.
+4. Propose a target directory structure.
+5. Generate a concrete restructuring plan.
+6. Validate the plan and identify potential conflicts.
+7. Execute approved operations using fs-tool.
+8. Verify the resulting filesystem against the original inventory and intended changes.
+
+The agent is responsible for reasoning, planning and deciding what should happen. The CLI is responsible for executing individual operations safely and reporting their results.
+
+## Development Rules
+
+- Python >=3.11, managed with `uv`.
+- Use Typer for the CLI.
+- Use type hints and clear module boundaries.
+- Prefer Python standard-library functionality where practical.
+- Follow PEP 8 and use four spaces for indentation.
+- Keep line length at approximately 100 characters.
+- Write tests for filesystem operations and safety-critical behavior.
+- Document CLI commands and their JSON output schemas.
+- Do not introduce MCP-specific dependencies into the core application.
+
+## Scope
+
+The initial implementation focuses exclusively on the filesystem CLI.
+
+Agent orchestration, autonomous planning, MCP adapters and advanced LLM integrations are future extensions and must not unnecessarily influence the initial architecture.

fs_tool_cli-0.1.2.dist-info/RECORD

@@ -0,0 +1,60 @@
+fs_tool/__init__.py,sha256=2uvKbmR-9AvE4npvNKjKegsrPDJbRk45S9XC6_eyiqs,306
+fs_tool/__main__.py,sha256=RgrOBWC8bydjUsRaA4XnyHamLPYWdsV970TXTzq0ayI,149
+fs_tool/cli.py,sha256=MMLB3g_it8r82kbIEzpbJAeARrwov4r_x6-GAz3eoI0,10165
+fs_tool/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fs_tool/core/__init__.py,sha256=wTesPXlDM1UOxzEmNsdDB-051e6ydEoHFWzz3LD-D1w,69
+fs_tool/core/config.py,sha256=Om6iHItguD5Vh3m3wVE-DQK077TUZ3YM25-OiAK8l-o,3875
+fs_tool/core/errors.py,sha256=T1w-UfbFV2_EfyqSo8j8hZn6ODMdja8LFiBM-dBzee0,2590
+fs_tool/core/filesystem.py,sha256=UnIG5eieJ4TyNfi_MI3ClLKT6WWSzKEN6hrxREhIPK0,1753
+fs_tool/core/hashing.py,sha256=5vBmnN1wNXiNU1Wem6JU-sx1s4hZcc6fWIzeqddRhWY,1345
+fs_tool/core/models.py,sha256=G46uYre47j9HOEDLCerBPBND6o8dC9zIFrJgO4wsBcc,1135
+fs_tool/core/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fs_tool/core/traversal.py,sha256=VnSQvpYoO394b8u5QhRWcovD6RxWmVQt831_Yd87DPw,7346
+fs_tool/output/__init__.py,sha256=w0HeI7Xqr3hwkc0Xxk61JixyVXK2o0-NsLSQXMRAdo0,67
+fs_tool/output/json.py,sha256=kalnq5kULdDJGLe4fc-3tvVyf1bghn0N3C5jfA5xZTY,3564
+fs_tool/output/plain.py,sha256=E-m0bshYkWYlM5Ce9NHYfepN5p1Ws75ZsVgi2IWu6KM,2018
+fs_tool/output/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fs_tool/safety/__init__.py,sha256=r2aGcaYSSRwRpdPon0_KXPJ1xQ8IaihHjclUKp5yIZE,76
+fs_tool/safety/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fs_tool/safety/validation.py,sha256=3hy1ebZN3yaRAGKGuD-6kYWDoy1POjCtJnvuA-yciE4,2628
+fs_tool_cli-0.1.2.data/data/share/fs-tool/docs/.nav.yml,sha256=LGgPFoDI0Hf-e0bu5SNMxRHlBmyfzLNLsufS0ebl_-k,426
+fs_tool_cli-0.1.2.data/data/share/fs-tool/docs/index.md,sha256=HC88svhf4rqRd9k2yUaM85xVjfXK0uTloS7xKJuLqZI,4072
+fs_tool_cli-0.1.2.data/data/share/fs-tool/docs/_static/img/favicon.png,sha256=aaM-uHn5DZZZEebsUVAG9Z3dhZToWxrZ_Rbr8qkDlgo,6706
+fs_tool_cli-0.1.2.data/data/share/fs-tool/docs/_static/img/logo.png,sha256=XUCtMQxigwuFFCLjStNUGpuVjXwXqtXE-hs90ZDU_v0,12578
+fs_tool_cli-0.1.2.data/data/share/fs-tool/docs/css/custom.css,sha256=_mwC18lgavuuRJbsWymsboLjJDx8_1Vezyr0nHQ0Hmk,93
+fs_tool_cli-0.1.2.data/data/share/fs-tool/docs/develop/contributing.md,sha256=-WS3xgzp_cS1AKni_MiGFACqudZgpXNGGzRbbtJqtF4,4812
+fs_tool_cli-0.1.2.data/data/share/fs-tool/docs/develop/naming_convention.md,sha256=t51w_FzR5KTyAyFcTfrLdBtSvhZSBd0JrKZI1qpSBzY,2769
+fs_tool_cli-0.1.2.data/data/share/fs-tool/docs/funding/funding.md,sha256=Bz8v7FgdhUzQSa64e2YOUR0FDy1SnI6DZYmhGXfiTLU,1822
+fs_tool_cli-0.1.2.data/data/share/fs-tool/docs/getting-started/install.md,sha256=vy3g7aoYCD9rRzReGdmTCTCjtipwOjOgUQZrlYDbZAY,607
+fs_tool_cli-0.1.2.data/data/share/fs-tool/docs/getting-started/virtual-environment.md,sha256=_RwN5X4XdVUOwvIPVfo08fk5gbmYRPk5a4fbLHOIFDQ,491
+fs_tool_cli-0.1.2.data/data/share/fs-tool/docs/usage/cli.md,sha256=VReBpkPo2-dISf_m8AgetzTd6csTxia4XWFfn-7V84U,225
+fs_tool_cli-0.1.2.data/data/share/fs-tool/res/example_filesystem_unstructured/Auslandssemester.docx,sha256=kFhV0WnTWtRB5MJM2b9Khlpbtn6JBH-Ra8B_Av8Thfo,14871
+fs_tool_cli-0.1.2.data/data/share/fs-tool/res/example_filesystem_unstructured/Barcelona Sehenswertes.docx,sha256=9HQGLBLMeChKi7MitWMqpQLfKO2feNfc6m1eDt6VpoU,8993
+fs_tool_cli-0.1.2.data/data/share/fs-tool/res/example_filesystem_unstructured/Der Goldschatz partygame.pdf,sha256=e3JcPLUk8XXzgIzGfWobVUjbUt9mzfgDNhykszFFxwo,29910
+fs_tool_cli-0.1.2.data/data/share/fs-tool/res/example_filesystem_unstructured/Reise-Checkliste.odt,sha256=LY_Rvs8hSiB9IZu73YGiXt6on2T2VH-hJZW7qwuEOng,22882
+fs_tool_cli-0.1.2.data/data/share/fs-tool/res/example_filesystem_unstructured/Sauna_Aufriss.odg,sha256=a4Gikr5jS5GaZG3hARNlRrXKMwBDabPkhCri-JRns6M,18147
+fs_tool_cli-0.1.2.data/data/share/fs-tool/res/example_filesystem_unstructured/Tokensystem Zähneputzen.odt,sha256=_6Ud1t2ni5Ahgv4SsMGUjhsl_3kPuRly1wLYQg1RUto,15188
+fs_tool_cli-0.1.2.data/data/share/fs-tool/res/example_filesystem_unstructured/Beruf/Bewerbungen.txt,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fs_tool_cli-0.1.2.data/data/share/fs-tool/res/example_filesystem_unstructured/Freizeit/Ablauf Freitag Grundschule.docx,sha256=Eqk6q7JtK-wXPr2HN6v60WdnOKHbFwTRJpUJ-PIQntA,6910
+fs_tool_cli-0.1.2.data/data/share/fs-tool/res/example_filesystem_unstructured/Freizeit/Dresdner Christstollen.pdf,sha256=MUBrBQ0q0YLVGgWbr-6U70RRsczXktUyGpzf-0i683o,14454
+fs_tool_cli-0.1.2.data/data/share/fs-tool/res/example_filesystem_unstructured/Freizeit/Kirschkuchen.pdf,sha256=begEeSK6T-iE8ZHz9TfRvZhyMX-RJamsVJbBChNHhRc,41349
+fs_tool_cli-0.1.2.data/data/share/fs-tool/res/example_filesystem_unstructured/Freizeit/Pelmeni.odt,sha256=OhdYgbZJ_62tYzsYfQeJLHrdHSGGE0JiTtbbkR2Ss0Y,15232
+fs_tool_cli-0.1.2.data/data/share/fs-tool/res/example_filesystem_unstructured/Freizeit/Seemeilenbestaetigung.pdf,sha256=gbomC5rRDj1kjHMGuBDLnpVoeyaP-c1U9PdLTeIRe6c,36722
+fs_tool_cli-0.1.2.data/data/share/fs-tool/res/example_filesystem_unstructured/Freizeit/Tidal Prediction Form.pdf,sha256=WcFzyBWBH7mGbC-lztlBX2q3ScUrKr8MwUJNiQY85A8,13369
+fs_tool_cli-0.1.2.data/data/share/fs-tool/res/example_filesystem_unstructured/Freizeit/Projekte/Sauna_Grundriss.odg,sha256=EABIPBU_WEv5yie-lH6hJ0QrlQH_MdQOcv7d8lVVpPc,14323
+fs_tool_cli-0.1.2.data/data/share/fs-tool/res/example_filesystem_unstructured/Reise/Segeln/Segeln Ibiza 2024.gpx,sha256=9tfDLkh0QzVayewo_LZghEL_3Bvo6cvaxLjAnVCbEgg,1478
+fs_tool_cli-0.1.2.data/data/share/fs-tool/res/example_filesystem_unstructured/Reise/Segeln/Dalmatien 2018/2017-08-26_19-18_Sat.gpx,sha256=gJ9kOwIb7YmJx7YPkfAAdqLo9dQpcLBdmwLerta5g50,17865
+fs_tool_cli-0.1.2.data/data/share/fs-tool/res/example_filesystem_unstructured/Reise/Slowenien/Klettersteige Slowenien.gpx,sha256=Kg5iMsfFJMQsCrTOIYmLibsXBBrWY1hIRmNUmqa1bM0,190661
+fs_tool_cli-0.1.2.data/data/share/fs-tool/res/example_filesystem_unstructured/Schule/Antrag Schülerausweis.docx,sha256=5VzmBsZPhvRVudNtHI9OsWLhRKXqGhM16HC9xzK9XAE,7631
+fs_tool_cli-0.1.2.data/data/share/fs-tool/res/example_filesystem_unstructured/Studium/Oberseminare 2009 Helduser.pdf,sha256=OqZhhkUIq1SCOfgFfv0UGd9eYsM529T7rOsBLKSGye8,46374
+fs_tool_cli-0.1.2.data/data/share/fs-tool/res/example_filesystem_unstructured/Urlaub/Der Weg zum SHS.ods,sha256=pB7s5hr2EfBSl0hVlkdpaW9trOAAIP1lTvLB8c4JY3U,19565
+fs_tool_cli-0.1.2.data/data/share/fs-tool/res/example_filesystem_unstructured/Urlaub/Italien/Klettersteige Italien 2024.kmz,sha256=2GxYqDSWVchuifS18nBIRDDURrVfq22ZJxa4ISSmm-M,10800
+fs_tool_cli-0.1.2.data/data/share/fs-tool/res/example_filesystem_unstructured/Urlaub/Radtouren/Gittersee-steinbach.gpx,sha256=mAOLuS7W_NbSXJo0O9m5RxUDyNtkfB_HkRk2-VdKU0E,41576
+fs_tool_cli-0.1.2.data/data/share/fs-tool/res/example_filesystem_unstructured/Urlaub/Radtouren/SingletrailDresdenerHeide.gpx,sha256=BbyybEbiOpcoGr8Ntuz6Gb3tKlSkekoj974r1HKl8dk,102217
+fs_tool_cli-0.1.2.data/data/share/fs-tool/res/example_filesystem_unstructured/Urlaub/Radtouren/StauseeInDerDresdnerHeide.gpx,sha256=uPBuXrQb_K01fIsJ8hMGx4N5uCHzhfxkLzn1kUJyQ44,48744
+fs_tool_cli-0.1.2.dist-info/licenses/LICENSE,sha256=awOCsWJ58m_2kBQwBUGWejVqZm6wuRtCL2hi9rfa0X4,1211
+fs_tool_cli-0.1.2.dist-info/METADATA,sha256=_0v8ETljC-9yvG2xTc8ob3AazyDe_5unF9MN4_alBGQ,4475
+fs_tool_cli-0.1.2.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+fs_tool_cli-0.1.2.dist-info/entry_points.txt,sha256=T-XY46ShiodyB-F7GzN84pJLUp1V9i62NMoGkr4TqKI,45
+fs_tool_cli-0.1.2.dist-info/top_level.txt,sha256=91OT2ORsRU-bICgBJ4V2ljcpmo7wG0_RgNgnNcIMKU8,8
+fs_tool_cli-0.1.2.dist-info/RECORD,,

fs_tool_cli-0.1.2.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

fs_tool_cli-0.1.2.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+fs-tool = fs_tool.cli:main

fs_tool_cli-0.1.2.dist-info/licenses/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org>

fs_tool_cli-0.1.2.dist-info/top_level.txt

@@ -0,0 +1 @@
+fs_tool