https://github.com/bodacious/crusoe
My personal gem for daily journal notes
https://github.com/bodacious/crusoe
Last synced: about 1 year ago
JSON representation
My personal gem for daily journal notes
- Host: GitHub
- URL: https://github.com/bodacious/crusoe
- Owner: Bodacious
- License: mit
- Created: 2023-10-29T17:09:21.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-17T10:56:29.000Z (about 2 years ago)
- Last Synced: 2025-04-22T20:08:13.489Z (about 1 year ago)
- Language: Ruby
- Size: 58.6 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Crusoe
[](https://github.com/Bodacious/crusoe/actions/workflows/main.yml)
A simple daily work journal from your command-line
```
# Open today's journal and add to it
$ crusoe
```
```
crusoe help
Commands:
crusoe help [COMMAND] # Describe available commands or one specific command
crusoe journal # This is the default task.
crusoe read # Read an entry
crusoe report # Generate a report for the last week
crusoe toc # Update the ToC on the README.md
```
## Installation
```
gem install crusoe
```
## Feature list
### Write to journal
#### `crusoe journal ✅`
- Write a single journal entry for given day (defaults to today)
- Automatically saves to git repo configured by you
- Default command for `crusoe`
- Can provide an optional `--date` value (e.g. one of `"today"`, `"yesterday"`, `"2023-12-25"`)
#### `crusoe read ✅`
- Read a single journal entry for given day (defaults to today)
- Can provide an optional `--date` value (e.g. one of `"today"`, `"yesterday"`, `"2023-12-25"`)
#### `crusoe report ✅`
- Print the entries from the current week
#### Organise journal in the README 🏗
- WIP: Keep an up-to-date index of all entries in the README
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/bodacious/crusoe.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).