Welcome to the Habit Tracker CLI

This is a powerful, command-line application designed to help you build, track, and analyze your habits directly from the terminal. Built with Python, SQLAlchemy, and Click, it offers a robust set of tools for personal development and data analysis.

This project was designed with a clean, decoupled architecture, making it easy to maintain, test, and extend.

Key Features

• Full Habit Management: Add, update, delete, and checkoff habits with simple commands.
• Flexible Periodicity: Track habits that are daily, weekly, or monthly.
• Powerful Analysis Engine: Gain insights into your performance with detailed analytics:
  • View all habits in a clean, formatted table.
  • Calculate the longest completion streak for any habit.
  • Identify your "most struggled" habits based on a unique scoring system.
  • Get a high-level summary of your progress.
• Safe Demo Environment: A sandboxed "playground" with a separate database and rich fixture with two months of data, allowing you to explore all features without affecting your real data.
• Intuitive CLI: A user-friendly command-line interface powered by click.

Navigation

To get started, please explore the pages of this wiki:

• Installation and Setup: Your first step to get the application running on your local machine.
• User Guide: Command-Line Usage: A complete reference for all available commands and their options.
• Using the Demo Environment: Learn how to use the safe, sandboxed demo mode.
• Developer Guide & Project Architecture: For contributors or anyone interested in the technical details of the project.
• API Reference: This reference manual details functions and classes describing what they are and what they do.