rubyental

rubyental is a visually enhanced command-line interface (CLI) application built with Ruby, designed to help you manage your mental well-being through a combination of todo lists and journaling. It features a striking red and white color scheme, utilizes the full terminal width, and provides a GUI-like experience directly in your terminal.

Features

• Visually Engaging Interface: Full-screen, clear, and structured output with a red and white color scheme.
• Enhanced Input: Utilizes the readline library for improved single-line input (e.g., arrow key navigation, history) in prompts.
• Todo List Management:
  • Add new tasks.
  • View your current tasks.
  • Mark tasks as complete.
  • Delete individual tasks.
  • Clear all tasks.
• Journaling:
  • Add dated journal entries with titles for easy sorting.
  • View all your journal entries.
  • Delete individual journal entries.
  • Clear all journal entries (with confirmation).
• Persistence: All your todo items and journal entries are saved automatically to local files (todo.txt and journal.txt) and loaded when you restart the application.

Getting Started

Prerequisites

You need Ruby installed on your system. You can download it from ruby-lang.org.

Installation

1. Clone the repository:

   git clone https://github.com/viztini/rubyental.git
   cd rubyental

2. Make the installation script executable:

   chmod +x install.sh

3. Run the installation script:

   ./install.sh

   This script will copy the rubyental application to ~/.local/bin and make it executable. It will also provide guidance if ~/.local/bin is not in your system's PATH.

Usage

After installation, you can run the application from any directory in your terminal by simply typing:

rubyental

Follow the on-screen menu to manage your todo list and journal entries.

Note on Text Editing: While readline enhances single-line input (allowing arrow key navigation and history for prompts), it does not provide full-screen, multi-line text editing capabilities (like navigating up/down within a multi-line entry). For such advanced editing, a dedicated text editor or a more complex terminal UI library would be required.

Example Output

================================================================================
                rubyental - Your Mental Well-being Companion
================================================================================
--------------------------------------------------------------------------------
                                   Main Menu
--------------------------------------------------------------------------------
1. View Todo List
2. Add Task
3. Mark Task Complete
4. Delete Task
5. Clear All Tasks
6. View Journal
7. Add Journal Entry
8. Delete Journal Entry
9. Clear All Journal Entries
10. Exit
--------------------------------------------------------------------------------
Choose an option:

File Structure

• rubyental.rb: The main Ruby application script with visual enhancements and readline integration.
• install.sh: The installation script.
• todo.txt: Stores your todo list items.
• journal.txt: Stores your journal entries.

Contributing

Contributions are welcome! If you have suggestions for improvements or new features, please feel free to open an issue or submit a pull request.

License

This project is open-source and available under the MIT License.