Skip to content

A simple cross-platform CLI tool built with Java to monitor and log application usage on your desktop.

License

Notifications You must be signed in to change notification settings

JonathanGunawan30/activityLog

Repository files navigation

ActivityLog CLI

A simple Java-based Command-Line Interface (CLI) tool to monitor and log application usage on your local machine. Built for educational purposes, this project demonstrates Java features, clean architecture principles, and interaction with the operating system.

ActivityLog CLI Demo


✨ Key Features

  • Real-time Tracking: Runs a background process to detect and log newly opened applications as they happen.
  • Daily Reports: Instantly generate a summary of today's application usage directly in your terminal.
  • Live Process List: Get a snapshot of all currently running processes, similar to a mini Task Manager.
  • CLI-Based: Lightweight, fast, and runs entirely from the command line.
  • Cross-Platform: Built with Java, it runs on Windows, macOS, and Linux.

🛠️ Tech Stack

  • Java 21: Built using a modern version of Java.
  • Maven: For project build and dependency management.
  • Picocli: A powerful framework for creating elegant, user-friendly command-line applications.

📋 Prerequisites

To run this application, you only need:

  • Java Runtime Environment (JRE) version 11 or newer.

⚙️ Installation & Usage

  1. Go to the Releases Page on this repository.
  2. Follow the instructions below based on your Operating System.

Important: You must place all downloaded files into the same folder for the application to work.

Available Commands

Here is a complete list of available commands:

Command Description
start Starts the monitor in the background to log any new application you open.
report Generates and displays a summary of today's logged activity.
list Shows a snapshot of all processes currently running on your system.
--help Displays this help message with a list of all commands.
--version Shows the application's version information.

For Windows Users

  1. From the latest release, download these two files:
    • ActivityLog-1.0-SNAPSHOT.jar
    • activitylog.bat
  2. Place both files in a new folder.
  3. Open a Command Prompt/PowerShell inside that folder.
  4. Run a command, for example: .\activitylog.bat report

For macOS & Linux Users

  1. From the latest release, download these two files:
    • ActivityLog-1.0-SNAPSHOT.jar
    • activitylog (the file with no extension)
  2. Place both files in a new folder.
  3. Open your Terminal inside that folder.
  4. Run this once to make the script executable: chmod +x activitylog
  5. Run a command, for example: ./activitylog report

About

A simple cross-platform CLI tool built with Java to monitor and log application usage on your desktop.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages