README.md
December 15, 2023 ยท View on GitHub
entry is now archived, please check out tdo for similar functionality
entry is a simple script that allows you to make daily entries/logs.
The purpose is to remove all barriers to Journaling and Note-taking.
It's as simple as running entry
โจ Features
- Automatically sets up an opinionated structure for notes
- Handles syncing with git, with timestamped commits, all async
Setup
โก Requirements
You will need an environment variable pointing to the directory where you want to store entries.
for example:
export ENTRY_DIR="$HOME/Projects/Notes/Journal"
If ENTRY_DIR is not configured you can either pass an arg, or the current directory will be used for entries.
๐ Installation
git clone https://github.com/2kabhishek/entry
cd entry
# Add a symlink to a directory on PATH
ln -sfnv $PWD/entry.sh $HOME/.local/bin/entry
๐ป Usage
USAGE:
entry [ENTRY_DIR]
Example:
entry $HOME/Notes/Todos
entry
Behind The Code
๐ Inspiration
Wanted to start Journaling again but was missing my entries because of the overhead
๐ก Challenges/Learnings
- I learned about async operations on bash and using git status in conditionals
๐งฐ Tooling
๐ More Info
- committer โ a tool to quickly commit and sync git
โญ hit the star button if you found this useful โญ
Source | Blog | Twitter | LinkedIn | More Links | Other Projects