https://github.com/giann/shiplog
⚓ A very simple journal keeping cli tool
https://github.com/giann/shiplog
cli journal lua
Last synced: 11 months ago
JSON representation
⚓ A very simple journal keeping cli tool
- Host: GitHub
- URL: https://github.com/giann/shiplog
- Owner: giann
- License: mit
- Created: 2019-11-22T04:49:45.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-06-02T13:58:19.000Z (almost 6 years ago)
- Last Synced: 2025-04-03T23:32:51.669Z (12 months ago)
- Topics: cli, journal, lua
- Language: Lua
- Homepage:
- Size: 65.4 KB
- Stars: 12
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ⚓ Shiplog
A very simple journal keeping cli tool
## Installation
```bash
luarocks install shiplog
```
## Usage
### Options:
- `-h`, `--help`: Show this help message and exit.
### Commands:
- `init`, `i`: Init shiplog database and git repository
- `add`, `a`: Write a log entry
- `modify`, `mod`, `m`: Modify a log entry
- `delete`, `del`, `d`: Delete an entry
- `list`, `ls`, `l`: List log entries
- `view`, `v`: View an entry
- `git`: Forward git commands to shiplog's repository
You can have a detailed help for each command with the `--help` option.
## Features
- [X] Write log entries
- [X] Tag entries
- [ ] Interactive mode with sirocco
- [X] User defined attributes
- [ ] Filter entries
+ [X] by tags
+ [ ] by attributes
- [ ] [Encrypt/Decrypt entries with gpg key](https://www.sqlite.org/see/doc/release/www/readme.wiki)
- [X] Sync over git repository
## Requirements
- SQLite3
- git