diff --git a/README.md b/README.md index e7f43d2..230f080 100644 --- a/README.md +++ b/README.md @@ -1,119 +1,126 @@ -# Fast Files (ff) +
+ + + +
-## Description +> Fast Files is a project consisting of two bash scripts, `ff` and `ffv`, that combine the functionality of `mkdir` and `touch`, enabling you to create directory structures and files in a single command. The `ffv` script additionally prints the created objects in a tree-like structure using `eza`, `lsd` or `ls`. -ff is a bash script which is a combination of 'mkdir' and 'touch'. It can create directory structures and files simultaneously and lists the created objects using eza, lsd, or ls. +## Scripts -## Dependencies +- `ff`: creates the specified files and directories without printing any output. +- `ffv`: performs the same operations as `ff` but also lists the created objects. + +## β¨ Features + +- Create single or multiple files and directories in one command. +- Automatically create parent directories as needed. +- Supports brace expansion for creating complex directory and file structures in one go. +- Optionally lists the created objects with enhanced listing tools (`eza` or `lsd`) if available, or fallback to `ls` (`ffv` only). + +## π οΈ Dependencies - bash -- [eza](https://github.com/eza-community/eza) (optional) -- [lsd](https://github.com/lsd-rs/lsd) (optional) +- Optional: [eza](https://github.com/eza-community/eza) or [lsd](https://github.com/lsd-rs/lsd) for enhanced directory listing -## Usage +## ποΈ Installation + +Place both scripts in a directory included in your `$PATH`. Ensure the scripts are executable: ```bash - ff [path file or folder] - --help : prints usage info +chmod +x /path/to/ff +chmod +x /path/to/ffv ``` -## Examples - -### Single file +## π Usage ```bash -ff file +ff [path file or folder] +ffv [path file or folder] ``` -``` - file -``` +### Arguments -### Single directory +- `--help` or `-h` : Prints usage information -```bash -ff dir/ -``` +### Examples -``` - dir -``` +- Create a single file: + ```bash + ff file + ``` + ``` + βββfile + ``` -### Multiple files +- Create a single directory: + ```bash + ff dir/ + ``` + ``` + βββdir + ``` -```bash -ff file1 file2 file3 -``` +- Create multiple files: + ```bash + ff file1 file2 file3 + ``` + ``` + ββfile1 + ββΌβfile2 + ββfile3 + ``` -``` - file1 - file2 - file3 -``` +- Create multiple directories: + ```bash + ff dir1/ dir2/ dir3/ + ``` + ``` + ββdir1 + ββΌβdir2 + ββdir3 + ``` -### Multiple directories +- Create a file in a directory: + ```bash + ff dir/file + ``` + ``` + βββdirβββfile + ``` -```bash -ff dir1/ dir2/ dir3/ -``` +- Create a directory within a directory: + ```bash + ff dir1/dir2/ + ``` + ``` + βββdir1βββdir2 + ``` -``` - dir1 - dir2 - dir3 -``` +- Create multiple files in multiple directories: + ```bash + ff dir1/dir2/file1 dir3/file2 + ``` + ``` + ββdir1βββdir2βββfile1 + ββ΄βdir3βββfile2 + ``` -### File in a directory +- Use [brace expansion](https://www.gnu.org/software/bash/manual/html_node/Brace-Expansion.html) for complex structures (supported in bash, zsh, fish): + ```bash + ff dir1/{dir2/{file1,file2}.txt,dir3/file3.txt} + ``` + ``` + ββfile1.txt + βββdir1ββ¬βdir2ββ΄βfile2.txt + ββdir3βββfile3.txt + ``` -```bash -ff dir/file -``` - -``` -dir -βββ file -``` - -### Directory in a directory - -```bash -ff dir1/dir2/ -``` - -``` -dir1 -βββ dir2 -``` - -### Multiple files in multiple directories - -```bash -ff dir1/dir2/file1 dir3/file2 -``` - -``` -dir1 -βββ dir2 - βββ file1 -dir3 -βββ file2 -``` - -### If your shell supports brace expansion e.g bash, zsh, fish - -```bash -ff dir1/{dir2/{file1,file2}.txt,dir3/file3.txt} -``` - -``` -dir1 -βββ dir2 -β βββ file1.txt -β βββ file2.txt -βββ dir3 - βββ file3.txt -``` - -## Related Projects +## π Related Projects [Advanced New File](https://github.com/tanrax/terminal-AdvancedNewFile) + +## β€οΈ Show Your Support + +Give a βοΈ if this project helped you.