/cyberlogs

journaling and logging app (currently just cli)

Primary LanguageRust

cyberlogs: cli journaling app

cieguito


With just a few keystrokes, you can create a journal entry, add your thoughts, and save them in the "journal/" directory, like whispers of your soul echoing in the void of cyberspace. The lightweight nature of this app makes it the perfect tool for tracking your ideas, progress, and memories as you wander through the dystopian landscape of your projects.

Features

  • Automatically generates a date-based text file.
  • Opens the created text file in your favorite text editor.
  • Organizes your journal entries in the "journal/" directory.
  • Customizable text editor in the provided run.sh script.

Installation

  1. Clone the repository:
git clone https://github.com/casiojapi/cyberlogs.git
  1. Build the project using cargo:
cd cyberlogs
cargo build --release

Usage

Option 1: execute the binary and open the file manually

  1. Run the binary:
./target/release/cyberlogs
  1. The output will reveal the path to the created file, e.g. "journal/2023-05-05_1919.txt". Open it using your text editor of choice:
vim journal/2023-05-05_1919.txt

Option 2:

  1. In this example, we'll use neovim as our text editor:
./target/release/cyberlogs | xargs nvim

Option 3: use the provided bash script (most convenient)

  1. First, grant execution permissions to the run.sh script:
chmod +x run.sh
  1. Modify the run.sh script to change the text editor, if desired.

  2. Run the script:

./run.sh

Use it anywhere

alias cyberlogs='/path/to/cyberlogs/run.sh'

Contributing

If you have questions, suggestions, or ideas for improvement, open an issue.