https://github.com/yamadapc/battlelogs

A minimal personal journaling system, for the command-line, I wrote for myself.
https://github.com/yamadapc/battlelogs

Last synced: 15 days ago
JSON representation

A minimal personal journaling system, for the command-line, I wrote for myself.

• Host: GitHub
• URL: https://github.com/yamadapc/battlelogs
• Owner: yamadapc
• License: gpl-2.0
• Created: 2014-09-12T23:19:44.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-09-16T19:19:50.000Z (over 10 years ago)
• Last Synced: 2024-12-24T11:57:42.536Z (17 days ago)
• Language: Haskell
• Size: 188 KB
• Stars: 1
• Watchers: 4
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# battlelogs

- - -

A minimal personal journaling system, for the command-line, I wrote for myself.

## Installation

To install, clone this repository to your machine and run:

```

cabal install

```

## Usage

```

$ blg

Usage:

      blg init

      blg commit [-m=]

      blg show

      blg [-hp]

Options:

      -h --help  Show this help message

      -p --path  Print the current `.battlelogs.md` in use

      -m --message Enter an entry without spawning an editor

```

To add entries to the battle log do:

```

$ blg commit -m "Hello World"

```

This will create a `.battlelogs.md` file in your `$HOME` directory and add an

entry to it. Typing `blg commit` without the `-m` flag will cause `blg` to open

your default text editor (`$EDITOR`) and capture its output, adding it to the

logs file.

The `blg init` command is meant to create "local" battle logs. Running it will

create an empty `.battlelogs.md` file in the current directory, which will

automatically become `blg`'s output file.

`blg show` (as of right now) will simply open the `.battlelogs.md` file in use

in the system's `$PAGER`. Pretty colors and a better logging display (and

format) are a _todo_.

## License

This code is licensed under the GPLv2 License. See [LICENSE](/LICENSE) for more

information.