https://github.com/smkent/captains-log

Simple personal logging application that stores daily plain text notes in a git repository
https://github.com/smkent/captains-log

git

Last synced: 2 months ago
JSON representation

Simple personal logging application that stores daily plain text notes in a git repository

• Host: GitHub
• URL: https://github.com/smkent/captains-log
• Owner: smkent
• License: gpl-3.0
• Created: 2016-12-15T08:23:16.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-02-04T21:40:07.000Z (over 9 years ago)
• Last Synced: 2025-06-12T17:50:00.213Z (about 1 year ago)
• Topics: git
• Language: Python
• Size: 23.4 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
`captains-log` is a simple daily personal logging application designed to store

short notes about each day in plain text.

The log is stored as individual files named for the corresponding date within a

`git` repository. Each addition or modification to the log also creates a

new commit in order to preserve the entire history of the log.

## Usage

`captains-log` organizes its main actions into commands, similar to `git`.

The available commands are `read`, `write`, `search`, and `history`.

A few shortcuts are available without specifying a command, such as being able

to simply enter a note into the current day's log by invoking `captains-log`

followed by text on the command line.

| Action | Example command |

| :-- | :-- |

| Write to the log for today | `$ captains-log Text to enter into the log` |

| Open `$EDITOR` to compose/edit today's log | `$ captains-log` |

| Edit the log entry for the previous day | `$ captains-log -d yesterday` |

| Show all log entries in reverse chronological order | `$ captains-log read` |

| Show just the log entry for today | `$ captains-log read today` |

| `grep` for a particular word in the log | `$ captains-log search text` |

Full usage information is available by running `captains-log --help`, or

`captains-log [command] --help` for information about a specific command.

## License

This program is free software: you can redistribute it and/or modify

it under the terms of the GNU General Public License as published by

the Free Software Foundation, either version 3 of the License, or

(at your option) any later version.

This program is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

GNU General Public License for more details.

You should have received a copy of the GNU General Public License

along with this program.  If not, see .

See [`LICENSE`](/LICENSE) for the full license text.