https://github.com/d2verb/mkt
A tool to make a temporary note
https://github.com/d2verb/mkt
Last synced: 9 months ago
JSON representation
A tool to make a temporary note
- Host: GitHub
- URL: https://github.com/d2verb/mkt
- Owner: d2verb
- License: mit
- Created: 2020-11-14T10:23:01.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-01-14T14:39:07.000Z (over 5 years ago)
- Last Synced: 2025-01-16T07:38:52.274Z (over 1 year ago)
- Language: Rust
- Size: 20.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mkt - MaKe a Temporary note
[](https://github.com/d2verb/mkt/actions)
[](https://github.com/d2verb/mkt/blob/master/LICENSE)
A tool to make a temporary note
## Usage
### help
```bash
$ mkt --help
mkt 0.1.0
A tool to make a temporary note
USAGE:
mkt [FLAGS] [OPTIONS] [prefix]
FLAGS:
-h, --help Prints help information
-o, --open Opens editor to edit note
-V, --version Prints version information
OPTIONS:
-e, --editor Editor to edit temporary note
-x, --extension Extension of temporary note
ARGS:
Prefix of temporary note
```
Note that the default value of `editor` is `vim` and the default value of `extension` is `md`.
### Example
#### 1. make note
```bash
$ mkt
$ ls
2020_11_14_19_13_45_y7vAA0a7.md
$ mkt mtg # you can also pass the prefix of the generated file
$ ls
2020_11_14_19_13_45_y7vAA0a7.md mtg_2020_11_14_19_16_16_y0Pdor7A.md
```
#### 2. make and edit note
```bash
$ mkt -o
[launch editor...]
```
## Configuration
If `$HOME/.mktrc` exists, mkt use it as a config file. The config file must consist of multiple lines like `key = value`.
```bash
$ cat ~/.mktrc
extension = "txt"
prefix = "mtg"
```
## LICENSE
MIT