A command-line tool designed to assist developers in managing and interacting with their projects efficiently. Leveraging the power of OpenAI's API, o1-engineer provides functionalities such as code generation, file editing, and project planning to streamline your development workflow.
-
Automated Code Generation: Generate code for your projects effortlessly.
-
File Management: Add, edit, and manage project files directly from the command line.
-
Project Planning: Create detailed plans based on your project requirements.
-
Interactive Console: User-friendly interface with rich text support for enhanced readability.
-
Cost Tracking: Monitor the usage and costs associated with API calls.
-
Conversation History: Save and reset conversation histories as needed.
-
Python: Ensure you have Python 3.7 or higher installed. Download Python
-
OpenAI API Key: Obtain an API key from OpenAI.
-
Clone the Repository:
git clone https://github.com/yourusername/o1-engineer.git
-
Navigate to the Project Directory:
cd o1-engineer -
Install Dependencies:
pip install -r requirements.txt
-
Configure APIs:
Add your API at the top of the script
client = OpenAI(api_key="YOUR API")
Launch the application using the following command:
python o1-eng.py-
exit: Quit the application. -
reset: Clear the conversation history. -
save: Save the current conversation history to a Markdown file. -
/add file1 [file2 ...]: Add specified files to the conversation context. -
/edit file1 [file2 ...]: Edit specified files based on AI suggestions. -
planning: Enter the planning mode to create detailed project plans.
You: /add src/main.py src/utils/helper.py
You: write a professional README.md for this projectWe welcome contributions! Please follow these steps:
-
Fork the repository.
-
Create a new branch (
git checkout -b feature/YourFeature). -
Commit your changes (
git commit -m 'Add some feature'). -
Push to the branch (
git push origin feature/YourFeature). -
Open a pull request.
- OpenAI for providing the powerful API.