Keyboard shortcuts

Press ← or β†’ to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

kasl

kasl: Key Activity Synchronization and Logging πŸ•’


Overview πŸ“–

kasl is a comprehensive command-line utility πŸ› οΈ designed to streamline the tracking of work activities πŸ“Š, including start times ⏰, pauses β˜•, and task completion βœ…. It automates the collection of work data πŸ“ˆ, facilitates task management πŸ“‹, and generates daily reports πŸ“, simplifying workflow and productivity tracking πŸš€.

Features 🌟

  • Automatic Data Collection πŸ“Š: Tracks the start of work sessions and pauses without manual input.
  • Task Management πŸ“‹: Easily add tasks and update completion percentages.
  • Daily Reports πŸ“: Auto-generates daily reports summarizing work activities.
  • API Integration 🌐: Sends daily reports to a specified API for easy access and storage.
  • User-Friendly 😊: Designed with a focus on simplicity and ease of use.

Getting Started πŸš€

Prerequisites πŸ“‹

  • Ensure you have a compatible operating system (Windows, macOS, or Linux) πŸ’».
  • Requires Node.js and npm (or an equivalent package manager) for running the utility πŸ“¦.

Installation πŸ› οΈ

Install kasl now. kasl is installed by running one of the following commands in your terminal. You can install this via the command-line with either curl or wget.

Install kasl via curl

sh -c "$(curl -fsSL https://raw.githubusercontent.com/lacodda/kasl/main/tools/install.sh)"

Install kasl via wget

sh -c "$(wget https://raw.githubusercontent.com/lacodda/kasl/main/tools/install.sh -O -)"

This will make the kasl application globally available in your system.

Usage πŸ“š

To start kasl and begin tracking:

kasl --help

Roadmap πŸ—ΊοΈ

  • Enhance task management with categories and priorities.
  • Integrate with more APIs for report submission.
  • Implement machine learning for predicting task completion time.
  • Add support for team collaboration features.
  • Develop a graphical user interface (GUI) version.

How to Contribute 🀝

Contributions are welcome! If you have ideas for new features or improvements, feel free to fork the repository, make your changes, and submit a pull request.

License πŸ“„

kasl is open-source software licensed under the MIT license. See the LICENSE file for more details.