f2t2f 0.1.1

A CLI tool to serialize folder structures to text and back.

f2t2f

A simple CLI tool to convert folder structures to and from a structured text format (JSON).

This is useful for sharing project structures, analyzing them with LLMs, or creating project templates.

Installation

pip install f2t2f

Usage

Folder to Text

To serialize the structure of ./my-project to the clipboard:

f2t2f copy ./my-project

To save it to a file instead:

f2t2f save ./my-project structure.json

Text to Folder

To create a folder structure from your clipboard into the current directory:

f2t2f paste

To create it from a file into a specific destination:

f2t2f load structure.json ./output-folder

Example Format

f2t2f uses a clear JSON format. For a folder structure like this:

my_app/
├── main.py
└── data/
    └── config.txt

Running f2t2f copy ./my_app would produce the following JSON:

{
  "type": "f2t2f_folder_structure_v1",
  "data": {
    "name": "my_app",
    "type": "folder",
    "children": [
      {
        "name": "data",
        "type": "folder",
        "children": [
          {
            "name": "config.txt",
            "type": "file",
            "content": "setting=True\n"
          }
        ]
      },
      {
        "name": "main.py",
        "type": "file",
        "content": "print(\"Hello, World!\")\n"
      }
    ]
  }
}

Configuration (Optional)

By default, f2t2f ignores common files like __pycache__ and .git. To customize this, you can create a configuration file.

1. Create the default config file:

   f2t2f config init
   

2. Find its location and edit it:

   f2t2f config path
   

   You can then add or remove patterns from the ignore_patterns list in that JSON file.

License

MIT License © Vova Auer