Skip to main content

๐Ÿ’ก 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 --months to view all months
  • Use idea --month 2024-03 to view a specific month
  • Use idea --search to search for specific content
  • Use idea --clear to 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


Download files

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

Source Distribution

ideajar-1.0.0.tar.gz (7.7 kB view details)

Uploaded Source

Built Distribution

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

ideajar-1.0.0-py3-none-any.whl (8.9 kB view details)

Uploaded Python 3

File details

Details for the file ideajar-1.0.0.tar.gz.

File metadata

  • Download URL: ideajar-1.0.0.tar.gz
  • Upload date:
  • Size: 7.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.12.7 Darwin/24.1.0

File hashes

Hashes for ideajar-1.0.0.tar.gz
Algorithm Hash digest
SHA256 c7789cf36c18d63ff279de907c10832fb515f29d15e8838c8430c0574e68b11f
MD5 26fc1bb7512e1d9331aeef622d755867
BLAKE2b-256 e7336ac5725f93650374db233e9c450796e9ec2f2b70b120f30c15e766b9fa4e

See more details on using hashes here.

File details

Details for the file ideajar-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: ideajar-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 8.9 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

Hashes for ideajar-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5df90d3973778dfea5881d1394d76e46b23566fdb9d53f740d62f18cdd584d37
MD5 952543ba61e2abf6caec4d4347ca783a
BLAKE2b-256 d138b024dfc7e7488e69c699931587267b49806a07d95e2457a876c210b7295f

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