README
¶
mk
Simply make files/folders
This command-line tool allows you to create directories and files using a
straightforward syntax. Directories are created using the +<folder> syntax,
where <folder> represents the directory name. The - syntax is used to remove
the last added directory from the directory stack. You can create empty files by
providing filenames, optionally nested within added directories. mk mantains
a directory stack to facilitate creating nested directories and files.
View example.
Tested on Linux (idk if it works on Windows and Mac)
Building
View BUILD.md
Usage
mk [+<folder>] [.<folder>] [-] [%'<command>'] [filename]
+<folder>: Create a new directory with the specified name and add it to the directory stack..<folder>: Create a new directory without adding it to the directory stack.-: Remove the last added directory from the directory stack. (Tip: You can stack in a single argument e.g.: mk +project +go -- README.md)%'<command>': Run a command in the current path (relative to the directory stack)filename: Create an empty file with the specified name. If directories are added to the directory stack, the file will be created within them. If the name starts with + or -, you can use #. View example
To disable output use:
MK_QUIET=true mk
# or
MK_QUIET=1 mk
Examples
Simple
Folder structure:
example/
├── test1/[empty]
├── test2/[empty]
├── test3/[empty]
├── test4/[empty]
├── test5/[empty]
├── test6/[empty]
├── test7/[empty]
├── test8/[empty]
└── test9/[empty]
To create it we use the following command:
mk +example .test{1..9}
mk
+example | Stack: [example]
.test{1..9} | Created: test1...9/; Stack: [example]
Complex
Folder structure:
example/
├── tool.go
├── README.md
└── files/
├── documents/
│ └── +page.svelte
├── projects/
│ └── go/
│ ├── main.go
│ └── README.md
└── output.txt
To create it we use the following command:
mk +example tool.go README.md +files +documents #+page.svelte - +projects +go main.go README.md -- output.txt
mk
+example | Stack: [example]
tool.go | Created: example/tool.go
README.md | Created: example/README.md
+files | Stack: [example, files]
+documents | Stack: [example, files, documents]
#+page.svelte | Created: example/files/documents/+page.svelte
- | Stack: [example, files]
+projects | Stack: [example, files, projects]
+go | Stack: [example, files, projects, go]
main.go | Created: example/files/projects/go/main.go
README.md | Created: example/files/projects/go/README.md
-- | Stack: [example, files]
output.txt | Created: example/files/output.txt
Running commands
Folder structure:
example/
├── go.mod
└── main.go
To create it we use the following command:
mk +example %'go mod init example.com/example' main.go
mk
+example | Stack: [example]
%'go mod init example.com/example' | Run command: "sh -c 'go mod init example.com/example'" at example/
main.go | Created: example/main.go
Directories