https://github.com/pinjasaur/jrnl
Frictionless journaling from the CLI
https://github.com/pinjasaur/jrnl
Last synced: 2 months ago
JSON representation
Frictionless journaling from the CLI
- Host: GitHub
- URL: https://github.com/pinjasaur/jrnl
- Owner: Pinjasaur
- Created: 2020-04-22T02:30:48.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-05-23T22:42:41.000Z (about 6 years ago)
- Last Synced: 2025-01-26T19:22:20.800Z (over 1 year ago)
- Language: Shell
- Homepage:
- Size: 4.88 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# jrnl
[](https://travis-ci.org/Pinjasaur/jrnl)
Frictionless journaling from the CLI.
Each day is a discrete plaintext file: `$JRNL_DIR/YYYY/MM/DD.txt`. Each entry
added will auto-prepend the time. Multiple entries in a single day will be
delimitted with Markdown-style `---` notation.
You can choose to add content directly from the CLI or edit an entry in your
preferrered `$EDITOR`.
## Installation
Requires Bash >= 4 (for [`globstar`][globstar]).
Add the [`jrnl` script](/jrnl) to your `$PATH` or create a function similar to:
```bash
jrnl() {
/path/to/jrnl "${@}"
}
```
`jrnl` defaults to writing to `$HOME/Journal`. You can customize this by setting
`$JRNL_DIR` to something else (e.g. `export JRNL_DIR="$HOME/Dropbox/Journal"`).
You'll also want to make sure `$EDITOR` is set to your preferred editor
(e.g. `export EDITOR='vim'`).
## Usage
Run `jrnl` to start writing. You can list entries with `jrnl --list` and show
the usage info with `jrnl --help`:
```
jrnl []
Creates a file in $JRNL_DIR/YYYY/MM/DD.txt.
Options:
-h --help Show this.
-l --list List entries.
Populate entry with . If not set, open with $EDITOR.
```
## Related
- [jot] - Create & manage Markdown files from the CLI
- [jt] - Quickly create timestamped notes (simplified version of [jot])
## License
[MIT][license] © Paul Esch-Laurent.
[jot]: https://github.com/Pinjasaur/jot
[jt]: https://github.com/Pinjasaur/jt
[license]: https://pinjasaur.mit-license.org/2020
[globstar]: https://www.linuxjournal.com/content/globstar-new-bash-globbing-option