๐ก A simple CLI tool to capture and store your brilliant ideas in a snap
Project description
IdeaJar ๐ก
A simple, fast command-line tool for capturing and storing your sudden flashes of inspiration and ideas.
๐ญ Why do you need IdeaJar?
Have you ever experienced moments like these:
- While programming, suddenly thinking of a brilliant project idea
- Having a flash of inspiration while working in the terminal, wanting to quickly record a thought
- Needing a simple tool to collect your creative ideas
IdeaJar was created to solve these problems! It allows you to quickly record any idea without leaving the terminal.
๐ Installation
pip install ideajar
๐ Usage
After installation, you can use the idea command anywhere!
๐ Record an idea
idea "Create a CLI tool for recording ideas"
Output:
๐ก Idea saved to March 2024: "Create a CLI tool for recording ideas"
๐ View ideas
View current month's ideas (default)
idea
View all historical ideas
idea --all
View ideas from a specific month
idea --month 2024-03
Example output:
๐ฏ Ideas from March 2024:
==================================================
--- Ideas from March 2024 ---
๐ก Monthly inspiration record
[2024-03-15 14:30:15] Create a CLI tool for recording ideas
[2024-03-15 14:32:22] Add dark mode to blog website
[2024-03-15 14:35:10] Learn Rust programming language
==================================================
๐ Search ideas
idea --search "CLI tool"
Output:
๐ Search keyword: "CLI tool"
==================================================
๐
March 2024:
[2024-03-15 14:30:15] Create a CLI tool for recording ideas
โ
Found 1 related idea.
==================================================
๐ Statistics and Management
View month list
idea --months
Count ideas
idea --count
Output:
๐ Ideas Statistics:
==============================
๐ March 2024: 3 ideas
๐ April 2024: 5 ideas
==============================
๐ฏ Total: 8 ideas
Clear all ideas (with enhanced safety)
idea --clear
โ ๏ธ Enhanced Safety Features: The clear command includes multiple confirmation steps to prevent accidental deletion:
- Shows detailed statistics of ideas to be deleted
- Requires typing "DELETE" to proceed
- Requires confirming the exact number of ideas
- Requires typing a random safety phrase as final confirmation
- Cannot be undone once completed
๐ View all commands
idea --help
๐ Data Storage
๐๏ธ New Version Storage Structure (v0.2.0+)
Ideas are now stored by month in the ~/.ideajar/ directory:
~/.ideajar/
โโโ 2024-03.txt # Ideas from March 2024
โโโ 2024-04.txt # Ideas from April 2024
โโโ 2025-09.txt # Ideas from September 2025
โโโ all_ideas.txt # Summary of all ideas (legacy compatibility)
Format of each monthly file:
--- Ideas from March 2024 ---
๐ก Monthly inspiration record
[2024-03-15 14:30:15] Create a CLI tool for recording ideas
[2024-03-15 14:32:22] Add dark mode to blog website
[2024-03-15 14:35:10] Learn Rust programming language
๐ Automatic Migration
If you previously used an older version (stored in ~/.ideas.txt), the new version will automatically migrate your data:
- Old data migrated to new directory structure
- Original file backed up as
~/.ideas.txt.backup - Seamless upgrade, no ideas lost!
โจ Features
- ๐ Extremely Simple & Fast: One command, instantly record ideas
- ๐ Monthly Organization: Ideas automatically organized by month, well-structured
- ๐ Powerful Search: Quickly find keywords across all historical ideas
- ๐พ Local Storage: All data stored in your home directory, completely private
- โฐ Automatic Timestamps: Each idea comes with precise time recording
- ๐จ Friendly Interface: Uses emoji and colors to make terminal more vivid
- ๐ Automatic Migration: Seamless upgrade from old versions, no data loss
- ๐ง Multiple Operations: Record, view, search, count, monthly management
- ๐ฑ Cross-platform: Supports Linux, macOS, and Windows
๐ฏ Use Cases
Developers
idea "Refactor user authentication module"
idea "Try using GraphQL to replace REST API"
idea "Add Docker support to the project"
Creative Workers
idea "Write a blog post about remote work"
idea "Design a minimalist style logo"
idea "Create a programming tutorial video series"
Daily Life
idea "Go hiking on the weekend"
idea "Learn to make Italian pasta"
idea "Finish reading 'Sapiens'"
๐ ๏ธ Technical Details
- Language: Python 3.8+
- Dependencies: Only uses Python standard library
- Storage: Plain text files (
~/.ideajar/*.txt) - Encoding: UTF-8 supports Chinese and emoji
๐ค Contributing
Issues and Pull Requests are welcome!
Development Environment Setup
git clone https://github.com/ideajar/ideajar.git
cd ideajar
poetry install
poetry shell
Run Tests
python -m pytest tests/
๐ License
MIT License - See LICENSE file for details.
๐โโ๏ธ FAQ
Q: Where are idea files stored?
A: Stored in the .ideajar/ directory in your home directory, organized by month.
Q: Can I backup my ideas?
A: Yes! Just copy the entire ~/.ideajar/ directory.
Q: How to search ideas?
A: Use the built-in search feature: idea --search "keyword"
Q: What if I have too many ideas? A: The new version automatically categorizes by month, you can:
- Use
idea --monthsto view all months - Use
idea --month 2024-03to view a specific month - Use
idea --searchto search for specific content - Use
idea --clearto clear all ideas (use with caution)
Q: Will upgrading from an old version lose data? A: No! The new version will automatically migrate old data to the new structure and backup the original file.
Q: How to check the number of ideas in a specific month?
A: Use idea --count to see monthly statistics and totals.
๐ก Start recording your ideas! Every great project begins with a simple idea.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ideajar-1.0.1.tar.gz.
File metadata
- Download URL: ideajar-1.0.1.tar.gz
- Upload date:
- Size: 7.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.2.1 CPython/3.12.7 Darwin/24.1.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
893860a667c08bbd9d89bb02ac70f032c5e52d4db6e4c4c4820fea26c5eb28d6
|
|
| MD5 |
2796debdff1bf9327c438ce492caf22b
|
|
| BLAKE2b-256 |
0ccc01c7d0f3b886e7f9d8df13bdb2b7e4c8dec837e08bf15102d28a0aaff30f
|
File details
Details for the file ideajar-1.0.1-py3-none-any.whl.
File metadata
- Download URL: ideajar-1.0.1-py3-none-any.whl
- Upload date:
- Size: 9.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/2.2.1 CPython/3.12.7 Darwin/24.1.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
aed98df114faa1177e0b9b606335f92e05e56eb5487381490310cc9d8df8f854
|
|
| MD5 |
bb0cfadc8d729f1ea6947b46d65ecf24
|
|
| BLAKE2b-256 |
40e711ba173f4c6a8ab2e08550bc2f635f09829d8e12522bfb4298f9bc54357b
|