ai-learn
v1.0.1
Published
A CLI for learning topics
Downloads
11
Maintainers
Readme
ai-learn
ai-learn is a command-line interface (CLI) tool designed to help users learn various coding topics by providing structured information, exercises, and prompts for leveraging AI tools like ChatGPT and Claude.
Table of Contents
Features
- Concise Explanations: Get clear and concise explanations of coding topics.
- Code Examples: View simple code examples demonstrating the topic.
- Common Misconceptions: Learn about common mistakes and how to avoid them.
- Real-World Applications: Discover scenarios where the topic is particularly useful.
- Practice Exercises: Access progressively challenging exercises to enhance your understanding.
- Automatic Prompt Copying: The generated prompt will be automatically copied to your clipboard for easy use with AI tools.
- AI Tool Integration: Prompts to guide users in searching for additional information using AI tools like ChatGPT, Claude, and others.
Installation
You can install the package globally using npm:
npm install -g ai-learn
Usage To use the CLI, run the following command in your terminal:
ai-learn
After Running the Command
- **Input Prompt: Follow the prompts to input your main topic ([X]) and sub-topic ([Y]).
- **Generated Output: The tool will generate a structured output that includes:
- ***Explanations
- ***Code examples
- ***Common misconceptions
- ***Real-world applications
- ***Exercises related to the topics you've chosen.
- **Automatic Copying: The generated prompt will be automatically copied to your clipboard.
What to Do Next
After running the command and receiving the output:
- Open your preferred AI tool, such as ChatGPT or Claude.
- Paste the copied prompt into the input field of the AI tool.
- Review the AI's response, which will provide you with further insights, examples, and clarifications on the topics you've chosen.
How It Works
Upon running the CLI, you will be prompted to enter a main topic ([X]) and a sub-topic ([Y]). The tool generates a structured output tailored to your inputs. The generated prompt will be automatically copied to your clipboard for easy use in AI tools, allowing you to engage with AI for deeper exploration and understanding.
AI Assistance
ai-learn not only provides structured information but also encourages users to engage with AI tools for further exploration and understanding. After receiving the generated prompt, you can easily paste it into AI tools like ChatGPT or Claude to gain deeper insights, clarify doubts, or receive additional examples and explanations.
Contributing
If you'd like to contribute to ai-learn, please feel free to open an issue or submit a pull request. Contributions are welcome!
1.Fork the repository. 2.Create a new branch (git checkout -b feature/YourFeature). 3.Make your changes and commit them (git commit -m 'Add some feature'). 4.Push to the branch (git push origin feature/YourFeature). 5.Open a pull request.
License
This project is licensed under the MIT License.
Keywords
CLI, Learning, AI Tools, Programming, Education