Filet

The ⚡ superfast ⚡ CLI tool to create file trees at the drop of a hat

Installation 📥

If you already have filet installed on your computer, you may want to update to the latest version.

1. Download (latest or desired version) filet.exe from the releases page
2. Add the path of the folder where you stored filet.exe to the system PATH variable like this
3. (Optional) Restart your computer and Filet is ready to be used in your favorite terminal! 🥳🎆

Usage 🔌 💻

Use the --help flag for instructions

$ filet --help
usage: main.py [-h] [--version] [--update] [--root [ROOT]] [--notree] struc

optional arguments:
  -h, --help            show this help message and exit

INFO:
  --version, -v         Prints out current version and release date of Filet
  --update, -u          Makes the update checker verbose

CREATE:
  --root [ROOT], -r [ROOT]
                        Location of root directory to create the filetree
  struc                 The structure of the filetree in filet syntax
  --notree              File tree will not be logged to console

Syntax 👩‍🏫

item	syntax	example1	example2
file	{file_name1}.{extension}+{file_name2}.{extension}	hello.py	server.js+auth.js
folder	{folder_name1}[]+{folder_name2}[]	src[]	api[]+auth[]
tree	{folder_name}[{file1}+{file2}+...]	src[main.jsx+data[users.json]]

Example 🥊

1. Create file tree in current directory

$ filet dir1[f1.txt+f2.txt+dir2[f3.txt]]
✔ Successfully created file tree

▼ dir1
    ∟ f1.txt
    ∟ f2.txt
    ▼ dir2
        ∟ f3.txt

2. Create file tree in specified directory using -r or --root arg

• Absolute path
  $ filet -r C://Users//ADMIN myfolder[images[]+important[bday.txt+todos.txt]]+software[README.txt]
  Creates file tree in C://Users//ADMIN directory

• Relative path
  $ filet --root ../tests myfolder[images[]+important[bday.txt+todos.txt]]+software[README.txt]
  Creates the file tree in the tests folder in parent directory of current directory (in which the terminal runs filet command)

Ignoring files (adding them to .gitignore)

Prefix the file or folder name in the filet structure argument to add it to a .gitignore file in the filet rootlocation

Example 🥊

$ filet -r D://Projects/pie_py src[main.py+pie.py+*ingredients.json+*tests[make_pie.py]]

This would create the file tree as usual, but with an additional file at D://Projects/pie_py/.gitignore, which contains -

src/ingredients.json
src/tests

When you initialize a git repository in D://Projects/pie_py, you will notice src/ingredients.json and src/tests are ignored by default by git

Updating

Manually

1. Download the desired (preferably latest) version of filet.exe from the releases page.
2. Save it in the directory where you have previously installed filet
3. 🎆 YAY! You have successfully updated filet on your computer

From CLI

• Filet automatically checks for updates each time it is run and will notify you about any new updates it finds.
• To make the update checking process verbose, use the --update or -u flag

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT