StudySync CLI is a terminal-based productivity and accountability tool for solo learners. It helps users plan focused study sessions, track their focus levels, and reflect on their learning progress over time.
- Start Study Sessions: Set up study sessions with customizable durations and break intervals
- Focus Tracking: Record your focus level after each break
- Session Summaries: View detailed summaries of completed sessions
- Progress Analysis: Track your weekly study patterns and focus trends
- Export Options: Save session data as JSON, text, or markdown
- Learning Insights: Capture key concepts during breaks and review them using spaced repetition principles
- Knowledge Graph: Visualize relationships between study topics
- Cat Animations: Enjoy cute cat animations that make studying more fun
- Python 3.6 or higher
- pip (Python package installer)
- Clone or download this repository
- Open Command Prompt or PowerShell
- Navigate to the project directory
- Create a virtual environment:
python -m venv venv - Activate the virtual environment:
.\venv\Scripts\activate - Install the required packages:
pip install -r requirements.txt
- Clone or download this repository
- Open Terminal
- Navigate to the project directory
- Create a virtual environment:
python3 -m venv venv - Activate the virtual environment:
source venv/bin/activate - Install the required packages:
pip install -r requirements.txt
- Activate your virtual environment (if not already activated)
- Run the application:
python studysync/main.py - Use the menu to navigate through the application
-
Start a Study Session:
- Select option 1 from the main menu
- Enter your study topic (e.g., "Python - Data Structures")
- Enter your goal (e.g., "Complete exercises 1-5")
- Set the total duration (e.g., 60 minutes)
- Set the break interval (e.g., 25 minutes)
- The session will start with a timer and a cute studying cat animation
- After each break interval, you'll be prompted to rate your focus (1-5)
- During breaks, you can capture key concepts you've learned
- The session ends when the total time is complete with a celebration cat animation
-
View Session Summary:
- After a session ends, you'll see a summary with:
- Total study time
- Focus scores for each break
- Average focus score
- The session data is automatically saved as a JSON file
- After a session ends, you'll see a summary with:
-
View Past Sessions:
- Select option 2 from the main menu
- Choose a session from the list to view its details
-
View Weekly Stats:
- Select option 3 from the main menu
- See your study patterns and focus trends for the past week
-
Learning Insights:
- Select option 4 from the main menu
- View your study topics with their learning effectiveness scores
- Review concepts that are due for review based on spaced repetition
- Add relationships between topics to build your knowledge graph
-
Knowledge Graph:
- Select option 5 from the main menu
- Visualize the connections between your study topics
- Navigate to build directory and download studysync.exe