Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/julien-fischer/cmd-mkf
A simple bash command that generates timestamped and preformatted files for meeting minutes, logs, and other documentation.
https://github.com/julien-fischer/cmd-mkf
Last synced: 5 days ago
JSON representation
A simple bash command that generates timestamped and preformatted files for meeting minutes, logs, and other documentation.
- Host: GitHub
- URL: https://github.com/julien-fischer/cmd-mkf
- Owner: Julien-Fischer
- License: apache-2.0
- Created: 2024-09-15T06:09:02.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2024-09-28T22:44:22.000Z (3 months ago)
- Last Synced: 2024-11-09T06:36:57.333Z (2 months ago)
- Language: Shell
- Homepage:
- Size: 20.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mkf (make file)
Save time by generating timestamped and preformatted files for your meeting minutes, logs, etc.
This command is designed to be simple to use and easily adaptable to your specific needs.
## Features
- **Automatic File Generation**: Create files with a name based on the current date and time in ISO format.
- **Customizable Templates**: Use preformatted templates to structure your documents, and create your owns.
- **Time-saving**: Automate file creation for your meetings, logs, or any other documentation needs.
## Customization
You can customize the templates used by the script or create your own by adding them to the `/usr/local/share/mkf/templates` directory.
## Prerequisites
- **Operating System**: Linux (tested on Debian 12 and Kubuntu 24)
- **Bash**: Ensure that Bash is installed on your system (usually installed by default on most Unix/Linux distributions)
## Parameters
Here is the output of `mkf -h`, showing all available options:
```
Usage:
mkf [filename] [-cdeotT][-ihv]
Main operation mode:
-c, --content=content The content to write in this file
-d, --directory=directory The directory where the file will be generated
-e, --extension=extension Specify the desired extension (no extension by default)
-o, --open[=software] Automatically opens the file upon generation using default or specified software.
-t, --time Uses a datetime prefix instead of a date prefix.
-T, --template=template_name Initializes the file using the specified template
Information output:
-h, --help Display this help message and exit
-i, --info Provide info about this software: version, release date, author
-v, --version Print the command version
```
## Examples
#### Create a file with default title and no extension
```
➜ mkf
created: 2024-09-15 in: /home/username/Desktop
```
#### Create a file with current datetime as prefix
```
➜ mkf -t
created: 2024-09-15_11-32-54 in: /home/username/Desktop
```
#### Create a file with default title and .txt extension
```
➜ mkf -e txt
created: 2024-09-15.txt in: /home/username/Desktop
```
#### Create and open a file with specified software (e.g. VIM)
```
➜ mkf -o vim
created: 2024-09-20 in: /home/username/Desktop
opening 2024-09-20 in vim
```
#### Create a file with initial content
```
➜ mkf stats.log -d ~/logs -c "hello world!"
created: 2024-09-15_stats.log in: /home/username/logs
➜ cat ~/logs/2024-09-15_stats.log
hello world!
```
#### Create a file from the specified template
```
➜ mkf important-meeting.txt -T meeting
created: 2024-09-15_important-meeting.log in: /home/username/meetings
```
## Install
1. Download or clone this repository:
```
git clone https://github.com/Julien-Fischer/cmd-mkf
```
2. Execute the installer
```
cmd-mkf/src/install.sh
```
3. Confirm `mkf` is installed:
```
mkf -v
```
## Uninstall
To remove `mkf`, run the uninstallation wizard.
```
/usr/local/bin/mkf-uninstall.sh
```
## Contributing
`mkf` is an open-source project; community contributions are welcome.
If you want to improve this script or add new features, feel free to open a pull request.
Please refer to [Contributing to mkf](https://github.com/Julien-Fischer/cmd-mkf/blob/master/CONTRIBUTING.md) for
more details.
## License
Apache 2.0. See [License](https://github.com/Julien-Fischer/cmd-mkf/blob/master/LICENSE).