Skip to main content

AI-powered journaling system with beautiful CLI for setup, customization, and updates

Project description

๐Ÿ“โœจ AI Journal Kit

Your Personal AI Coach for Journaling, Growth & Clarity
100% Private โ€ข Fully Customizable โ€ข Works with Any Framework

PyPI version License: MIT Python 3.10+

Quick Start โ€ข Features โ€ข Installation โ€ข Documentation


๐ŸŽฏ Why AI Journal Kit?

๐Ÿ” 100% Private

Your journal stays on YOUR computer. No cloud sync required. No data collection. No privacy compromises.

๐ŸŽจ Fully Customizable

Adapt to YOUR workflow. Use any journaling method: GTD, PARA, Bullet Journal, Zettelkasten, or create your own.

๐Ÿค– AI-Powered Intelligence

Your personal AI coach proactively:

  • โœ… Updates your notes as you talk
  • โœ… Captures insights and breakthroughs
  • โœ… Recognizes patterns you might miss
  • โœ… Provides accountability without judgment
  • โœ… Helps you reflect and grow

๐Ÿ› ๏ธ Works Everywhere

Built for YOUR favorite tools:

  • Cursor โ€ข Windsurf โ€ข Claude Code โ€ข GitHub Copilot
  • Or any markdown editor!

โšก Quick Start (60 Seconds)

1๏ธโƒฃ Install & Setup

uvx ai-journal-kit setup

That's it! The AI will guide you through setup interactively.

2๏ธโƒฃ Open Your Journal

# Open in your AI editor
cursor ~/journal     # or wherever you chose
windsurf ~/journal
code ~/journal

3๏ธโƒฃ Start Talking

Just say:

"Help me get started"

The AI will introduce itself and guide you through customization!


๐ŸŽ What You Get

๐Ÿ’ฌ Natural Conversation

Talk naturally with your AI coach. No rigid commands or syntax.

You: "I'm feeling overwhelmed with this project"
AI: "Let's break it down. What's the biggest blocker right now?"
     [Automatically creates project note and captures your thoughts]

๐Ÿง  Automatic Memory Capture

The AI recognizes significant moments and offers to save them:

You: "I just realized I procrastinate when I'm afraid of failing"
AI: "That's a powerful insight. Want me to capture this as a memory?"

๐Ÿ“Š Smart Pattern Recognition

Your AI coach spots patterns you might miss:

AI: "I notice you mention feeling tired every Wednesday. 
     Want to explore what's happening mid-week?"

๐ŸŽฏ Proactive Updates

No manual note-taking! The AI updates your notes automatically:

  • Daily notes - Progress, wins, challenges as they happen
  • Project notes - Status updates, blockers, decisions
  • People notes - Conversations, action items, context
  • Memories - Breakthroughs, insights, patterns

๐Ÿ—๏ธ Architecture

Two Separate Layers

๐Ÿ”ง Core System (Maintained by project)

Templates, AI rules, and tools that can be updated:

ai-journal-kit/
โ”œโ”€โ”€ templates/          # Daily, project, people templates
โ”œโ”€โ”€ ide-configs/        # AI rules for each editor
โ””โ”€โ”€ cli/               # Setup and update tools

๐Ÿ““ Your Journal (100% Yours)

Your private content that never changes on update:

~/journal/
โ”œโ”€โ”€ daily/             # Your daily notes
โ”œโ”€โ”€ projects/          # Your projects
โ”œโ”€โ”€ people/            # Your relationships
โ”œโ”€โ”€ memories/          # Your insights
โ”œโ”€โ”€ .ai-instructions/  # Your custom AI behavior
โ””โ”€โ”€ [any structure you want!]

Updates are safe: Only the core system updates. Your journal stays untouched!


๐Ÿš€ Installation

Option 1: Quick Run (Recommended)

# Install and setup in one command
uvx ai-journal-kit setup

Option 2: Global Install

# Install globally
pip install ai-journal-kit

# Run setup
ai-journal-kit setup

Option 3: With UV

# Install as a tool
uv tool install ai-journal-kit

# Run setup
ai-journal-kit setup

๐ŸŽ›๏ธ CLI Commands

# Interactive setup wizard
ai-journal-kit setup

# Check journal health
ai-journal-kit status

# Update to latest version
ai-journal-kit update

# Update with new templates
ai-journal-kit update --templates

# Diagnose and fix issues
ai-journal-kit doctor

# Move journal to new location
ai-journal-kit move

๐ŸŒŸ Key Features

๐ŸŽจ Framework Agnostic

Not opinionated! Use any journaling methodology:

  • GTD (Getting Things Done)
  • PARA (Projects, Areas, Resources, Archive)
  • Bullet Journal
  • Zettelkasten
  • Your own system!

The AI adapts to YOUR structure, not the other way around.

๐Ÿ›ก๏ธ AI Protection Built-In

The AI cannot modify:

  • โœ… Your core system files
  • โœ… Your journal content (unless you ask)
  • โœ… Your configuration

Safety first!

๐Ÿ”„ Transparent Updates

When updates change AI behavior:

  • โœ… Clear changelog highlighting changes
  • โœ… Release notes explaining why
  • โœ… You control when to update
  • โœ… Templates update with backup

No surprises!

๐ŸŽญ Multiple Editor Support

Cursor

journal/
โ””โ”€โ”€ .cursor/
    โ””โ”€โ”€ rules/
        โ”œโ”€โ”€ journal-coach.mdc
        โ”œโ”€โ”€ daily-notes.mdc
        โ””โ”€โ”€ system-protection.mdc

Windsurf

journal/
โ””โ”€โ”€ .windsurf/
    โ””โ”€โ”€ rules/
        โ”œโ”€โ”€ journal-coach.md
        โ””โ”€โ”€ daily-notes.md

Claude Code

journal/
โ”œโ”€โ”€ CLAUDE.md          # Root instructions
โ”œโ”€โ”€ daily/
โ”‚   โ””โ”€โ”€ CLAUDE.md      # Daily-specific rules
โ””โ”€โ”€ projects/
    โ””โ”€โ”€ CLAUDE.md      # Project-specific rules

GitHub Copilot

journal/
โ””โ”€โ”€ .github/
    โ”œโ”€โ”€ copilot-instructions.md
    โ””โ”€โ”€ instructions/
        โ””โ”€โ”€ daily-notes.instructions.md

๐ŸŽ“ How It Works

Morning Check-In

You: "Get the time and let's start the day"

AI: "Good morning! It's 6:30 AM on Friday, Nov 7, 2025.

     How did you sleep? โญโญโญโญโญ (Rate 1-5)"

[Creates today's daily note, captures your energy level, 
 helps you set priorities and emotional outcomes]

Throughout the Day

You: "Just finished that proposal! Feeling great."

AI: "Awesome! ๐ŸŽ‰ That's a big win."

[Automatically updates your daily note:
 "**2:30 PM** - Completed proposal draft! Feeling accomplished."]

Evening Reflection

You: "Update my daily note"

AI: "Let's reflect on today:
     - What went well?
     - What challenges came up?
     - What did you learn?
     - What's your top priority tomorrow?"

[Captures your reflection in the daily note]

๐Ÿ› ๏ธ Customization

Your AI, Your Way

Create .ai-instructions/my-coach.md:

# My Coaching Preferences

## Style
- Be concise and direct
- Challenge me when I'm avoiding something
- Celebrate wins enthusiastically

## Focus Areas
- Deep work and focus
- Work-life balance
- Health and fitness

## Don't
- Be overly supportive (I need pushback)
- Let me procrastinate

The AI will follow YOUR preferences!

Custom Templates

Modify any template:

# Edit templates in your journal
journal/daily-template.md
journal/project-template.md
journal/people-template.md

On setup, the AI uses YOUR templates automatically!


๐Ÿ” Privacy & Security

Your Data Stays Yours

  • โœ… Everything stored locally
  • โœ… No cloud sync required
  • โœ… No telemetry or tracking
  • โœ… No data collection
  • โœ… 100% private

AI Access

  • โœ… Your chosen AI editor processes locally or via their API
  • โœ… You control what the AI can read/write
  • โœ… System protection prevents accidental modifications
  • โœ… You can review every change

๐Ÿ“š Documentation

Getting Started

Templates & Examples

All templates are in your journal after setup:

  • daily-template.md - Daily note structure
  • project-template.md - Project tracking
  • people-template.md - Relationship notes
  • memory-template.md - Capturing insights

Advanced

  • Multi-computer setup: Use cloud storage for journal/ folder
  • Team journaling: Share templates via git
  • Integrations: Beeminder, RescueTime, ClickUp (examples in docs)

๐Ÿค Contributing

We welcome contributions!

  • ๐Ÿ› Bug reports: Open an issue
  • ๐Ÿ’ก Feature requests: Start a discussion
  • ๐Ÿ“– Documentation: Improve guides and examples
  • ๐ŸŽจ Templates: Share your custom templates
  • ๐Ÿ”ง Code: Submit pull requests

See CONTRIBUTING.md for guidelines.


๐Ÿ’ฌ Community

  • GitHub Discussions: Ask questions, share tips
  • Issues: Report bugs, request features
  • Show & Tell: Share your setup and workflows

๐Ÿ“– Examples & Use Cases

For Entrepreneurs

- Track multiple projects and ventures
- Capture business insights and lessons
- Manage relationships with clients and partners
- Reflect on wins, challenges, and growth

For Developers

- Document technical decisions and learnings
- Track bug investigations and solutions
- Manage multiple projects and codebases
- Reflect on code reviews and improvements

For Students

- Organize notes across classes and subjects
- Track assignments and deadlines
- Capture study insights and understanding
- Reflect on learning progress

For Personal Growth

- Daily gratitude and reflection
- Goal setting and tracking
- Habit formation and accountability
- Emotional processing and awareness

๐ŸŽฏ Philosophy

No Judgment

The AI creates psychological safety. Gaps are normal. Progress over perfection.

Proactive, Not Reactive

The AI updates notes automatically as you talk. You shouldn't have to remember to journalโ€”it happens naturally.

Conversational, Not Transactional

Talk naturally. No commands, no syntax, no friction.

Your System, Your Rules

Not opinionated about methodology. Adapts to YOUR way of working.


๐Ÿšฆ Roadmap

โœ… Completed (v1.0)

  • Multi-editor support (Cursor, Windsurf, Claude Code, Copilot)
  • Cross-platform CLI with beautiful UI
  • Automatic memory capture
  • Pattern recognition
  • Safe updates with transparency

๐ŸŽฏ Planned

  • Web dashboard for insights and analytics
  • Mobile companion app
  • Voice input support
  • Advanced integrations (calendar, task managers)
  • Community template library
  • Multi-language support

โ“ FAQ

Q: Is my data private?
A: Yes! Everything stays on your computer. No cloud, no tracking, no data collection.

Q: Do I need an AI editor?
A: No! Works with any markdown editor. AI features are optional but recommended.

Q: Can I use my own journaling system?
A: Absolutely! Not opinionated. Use GTD, PARA, Bullet Journal, or your own method.

Q: Will updates break my journal?
A: Never. Updates only touch system files, never your content or customizations.

Q: Can I customize the AI's behavior?
A: Yes! Create .ai-instructions/ files to define your coaching preferences.

Q: How much does it cost?
A: The AI Journal Kit is free and open source (MIT License). You only pay for your chosen AI editor (Cursor, Windsurf, etc.) if using AI features.

Q: Can I sync across computers?
A: Yes! Put your journal/ folder in Dropbox, Google Drive, or iCloud. The CLI stays installed per-machine.


๐Ÿ™ Credits

Built with love for better journaling and personal growth.

Author: Troy Larson (@troylar)
License: MIT
Repository: github.com/troylar/ai-journal-kit


๐Ÿ’ Support

If AI Journal Kit helps you, consider:

  • โญ Star the repo to help others discover it
  • ๐Ÿฆ Share your experience on social media
  • ๐Ÿค Contribute templates, docs, or code
  • ๐Ÿ’ฌ Spread the word to friends who journal

Ready to transform your journaling?

uvx ai-journal-kit setup

Let's go! ๐Ÿ“โœจ

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ai_journal_kit-1.0.9.tar.gz (132.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ai_journal_kit-1.0.9-py3-none-any.whl (93.9 kB view details)

Uploaded Python 3

File details

Details for the file ai_journal_kit-1.0.9.tar.gz.

File metadata

  • Download URL: ai_journal_kit-1.0.9.tar.gz
  • Upload date:
  • Size: 132.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.19

File hashes

Hashes for ai_journal_kit-1.0.9.tar.gz
Algorithm Hash digest
SHA256 e9e6c3eccfe45e66b8a9da6d656302f1c0e1c838bd33c59679331b5272328e9f
MD5 c01b57bbed94d5d421eba90aa7ab44f6
BLAKE2b-256 294504d61cfdd3bd7c481daa56abbf2040f01970ef9f73651fe3746a5120ebfe

See more details on using hashes here.

File details

Details for the file ai_journal_kit-1.0.9-py3-none-any.whl.

File metadata

File hashes

Hashes for ai_journal_kit-1.0.9-py3-none-any.whl
Algorithm Hash digest
SHA256 6c8cae27ff2cba0888eb4fe7caeefa54cb8683241d85d51299e8549986f996c3
MD5 baf351f0a04d24378257dbbf7a366b74
BLAKE2b-256 ffbeeba8edcbb428e22264080a767f0881c72c6e40723b05b09e8cd143a34d13

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page