π A CLI tool for guided reflections and journaling, offering a variety of prompts and tracking features to enhance your writing journey.
π― Thoughtful Prompts
- Growth and personal development
- Daily gratitude practice
- Mindfulness exercises
- Thought-provoking questions
- Quote-inspired reflections
π Progress Tracking
- Writing streaks and milestones
- Word count analytics
- Time spent writing
- Mood patterns
- Entry themes
π Privacy-First Design
- Local storage only
- Offline accessibility
- Complete data ownership
npm install -g rflect
During setup, you'll set up a configuration file to store your preferences:
rflect init
rflect
uses local storage:
- Entries are stored in
~/.rflect/entries/
- Complete offline access
- Private journaling as it saves the entries in the user's file system
Write a new reflection
rflect write
Browse past reflections
rflect show [options]
--all
: Display all entries.--recent
: View the most recent entry.--date
: Find entries from a specific date.--tag
: Find reflections with a specific tag.--category
: Find reflections by prompt type.--mood
: Find reflections by mood.
Browse the available writing prompts
rflect prompts [options]
--all
: View all prompts.--category <type>
: View prompts by category (mindfulness, gratitude, growth, question, or quote).
Discover themes throughout your entries
rflect tags [options]
--all
: View all your used tags.--top
: See your 5 most frequent reflection themes.
Track your emotional journey
rflect moods [options]
--frequency
: See patterns in your recorded moods.--calendar
: View your monthly mood patterns.
Customize and manage your configuration settings
rflect config [options]
--install
: Reinstall rflect configuration file and directories.--name
: Set your display name.--show
: View current settings.--editor <boolean>
: Toggle system editor usage.--goal
: Configure word count or writing frequency goals.--type <entries|words>
: Goal type.--frequency <daily|weekly|monthly>
: Goal frequency.--value <number>
: Goal value.
View statistical insights of your writing
rflect stats [options]
--all
: Show comprehensive statistics.--streak
: View streak and progress towards streak goal.--goals
: Show progress on all writing goals.--entries
: Display entry count and word statistics.--time
: Display time-related statistics.
Manage reflection history
rflect delete [options]
--all
: Remove all entries.--date
: Remove entries from a specific date.
See a list of upcoming features: Discover upcoming features like custom themes, cloud backup, search, reminders, encryption, and AI insights.
rflect upcoming
- Core:
node.js
,commander
,inquirer
- Date Handling:
calendar-js
,date-fns
- Styling:
chalk
- Development:
nodemon
,eslint
,prettier
- Node.js: Version 14.0.0 or higher
- Operating System: macOS, Linux, or Windows
npm run dev # Run with nodemon for development
npm run lint # Run ESLint checks
npm run format # Format code with Prettier
npm version [major|minor|patch] # Bump version and create tag
git push && git push --tags # Push changes
Contributions and suggestions are always welcome!
This project is licensed under the MIT License.