A simple, terminal-based journaling application leveraging Tmux. It allows adding entries, viewing the journal, and deleting specific entries.
![Jouranl App Screenshot](https://private-user-images.githubusercontent.com/13922212/300232384-74ddf138-64c0-4e92-8f2e-de459b0ee1dd.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjYxNDUwMDksIm5iZiI6MTcyNjE0NDcwOSwicGF0aCI6Ii8xMzkyMjIxMi8zMDAyMzIzODQtNzRkZGYxMzgtNjRjMC00ZTkyLThmMmUtZGU0NTliMGVlMWRkLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA5MTIlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwOTEyVDEyMzgyOVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTM4ZjdhYTI0YTNiYzYwNTQwODk3MjUzZDMzYzI4ZGRhZmM5YjdiNzVhZmQxNTkxODdhOGU4ZGY1YTk0ZDM1NTYmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.bsSoGY9rg518tnN11FK1tl2tnWr9k1FbdvadGQPRK_M)
- Real-time Journal Viewing: Continuously tails the journal file, displaying updates as they happen.
- Interactive Entry Addition: Prompts for and adds new journal entries.
- Line Removal: Deletes specific lines from the journal.
- Dynamic Commands: Supports various commands like adding the current date, refreshing the app, and quitting.
- Clone Repository: Clone this repository to your local machine.
- Edit Start Directory: Redefine DIR variable to point to the same directory as the journal.sh script.
- Initial Setup: Run the provided setup script to initialize the application.
- Aliasing: Launch app through journal command by appending to the .bash_profile -- aliasing journal='{path}/start_journal_app.sh'
- Run
./start_journal_app.sh
to start the Tmux session with all panes configured. or - Type journal command to launch if already aliased.
- Main Pane: Shows the real-time view of your journal.
- Entry Addition Pane: Add new journal entries.
- Command Handler Pane: Enter commands to interact with the journal.
quit
: Exits the application.date
: Appends the current date to the journal.remove <line_number>
: Removes the specified line from the journal.refresh
: Refreshes the journal view and entry addition pane.
- Journal Directory: Set the journal directory in the
start_journal_app.sh
script. - Journal File: By default,
journal.txt
is used. Change this in the script if needed. - Aliasing: Improve convenience by aliasing to journal command. Change this in the .bash_profile if needed.
- Tmux: Ensure Tmux is installed on your system.
- Bash: Scripts are written for Bash.
- Cross-platform Compatibility:
sed
command usage might vary based on the operating system.
Feel free to fork the repository and submit pull requests.
Danh Tran