Home

Ideacli

Overview

Ideacli is a command-line tool for managing idea responses from language models. It helps developers and creators organize, store, and interact with AI-generated code and content in a structured way. The tool provides a streamlined workflow for turning AI assistance into actionable projects.

Features

• Store and Organize Ideas: Save LLM-generated responses with unique IDs for easy reference
• Extract Code: Automatically extract code samples from idea responses into actual files
• Manage Multiple Ideas: Keep track of various project ideas in a centralized repository
• Incremental Updates: Add to existing ideas without losing previous content

Installation

Clone the repository

git clone https://github.com/yourusername/ideacli.git

Install the package

cd ideacli
pip install -e .

Use pip install -e ".[dev]" to install dev tools

Commands

Refer to the individual command pages for detailed explanations:

• Initialize Repository
• Add an Idea
• Enquire an AI
• Update an Idea
• List Idea Files
• Extract Idea Files
• Rename an Idea
• Import a File
• Remove a File

Workflow Example

Plan a new project feature:

ideacli init --path myproject

Add a new idea:

ideacli add

This will store the idea and put the <unique_id> for it in your paste buffer. Ask an AI assistant to create a new feature:

ideacli enquire --prompt 'add this to that' --id <unique_id>

This will place a JSON request in your clipboard for passing to an LLM. Put the LLM's response in your paste buffer then save the response:

ideacli update --id <unique_id>

Check what files will be created:

ideacli files --id <unique_id>

Extract the files to your project:

ideacli extract --id <unique_id>

Iterate and improve.

Architecture

Ideacli stores ideas as JSON files in a designated repository directory. Each idea has a unique ID and can contain:

• Subject: A brief title describing the idea
• Body: The full prompt or request
• Response: The LLM's response, including:
  • Approaches: Different ways to solve the problem
  • Files: Code files that implement the solution
  • Conclusion: A summary of the solution

This structure ensures ideas are well-organized and easily accessible.

Tips and Best Practices

• Use Descriptive IDs: Choose meaningful IDs for your ideas to make them easier to remember
• Incremental Development: Add to existing ideas rather than creating new ones for every iteration
• Combine with Version Control: Use ideacli alongside git to track the evolution of your projects
• Save Prompts: Keep your original prompts in the idea record for future reference

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.