Welcome to Pineapple for Xcode, an open-source extension that supercharges your development experience on Apple platforms by integrating OpenAI’s ChatGPT functionalities!
Table of Contents
- Getting Started
- Prerequisites
- Setup
- Usage
- Roadmap
- Contributing
- Support
- License
- Acknowledgements
- Copyright
Getting Started
Prerequisites
Before you dive into using Pineapple for Xcode, ensure you have the following:
- Xcode Version 14.3 (14E222b) or newer. The project is compatible with Xcode 14.0.
- macOS 13.3 or higher.
Setup
Follow these steps to set up Pineapple for Xcode:
- Clone this Repository
- Open the Xcode Project, navigate to Project Targets, and update the Signing Capabilities with your Bundle Identifier.
- You shouldn’t need a Provisioning Profile to run the extension locally.
- Run the Pineapple for Xcode macOS target first, and enter your OpenAI API Key.
- To debug, execute the Pineapple extension target, which opens a new instance of Xcode with the extension enabled.
Usage
Refer to our Docs to learn how to use this extension. If you find the Pineapple menu grayed out in the Xcode Editor Menu, simply quit Xcode (cmd+Q) and reopen it.
Roadmap
We’re continuously improving Pineapple for Xcode. Here’s what is on our roadmap:
- Mac App UI:
- [x] Add/Remove OpenAPI Key
- [x] Securely store API Key with Apple’s Keychain
- [ ] Add GPT customizations (Model, Max Tokens, Temperature, etc.)
- [ ] Implement loading states while executing a command
- Xcode Commands:
- [x] Refactor Selected Code
- [x] Shorten Selected Code
- [x] Generate Code from the current single-line comment
- [ ] Generate Code from selected multi-line comments
- [x] Document Selected Code
- [ ] Identify Potential Bugs in Selected Code
- [ ] Fully Support Swift, SwiftUI, Obj-C, Obj-C++, C, C++
Contributing
Your contributions can help enhance Pineapple for everyone! Please create bug reports that are:
- Reproducible: Include steps to reproduce the problem.
- Specific: Share as much detail as possible, such as version, environment, etc.
- Unique: Ensure that your report isn’t already open.
- Scoped: Stick to one bug per report.
Please adhere to our project’s code of conduct.
Support
Need help? Reach out to us on:
- Discord Server
- The email found in our GitHub Profile
For more insights, updates, or to collaborate on AI development projects, stay connected with fxis.ai.
License
This project is licensed under the AGPL-3.0 license. See LICENSE for more information.
Acknowledgements
Special thanks to dec0dOS for the README template.
Copyright
The Pineapple logo, and Dhamova logo are registered trademarks of Dhamova Innovations Inc.
Troubleshooting
If you encounter issues during setup or usage, ensure:
- Your Xcode version is compatible.
- You have correctly set your Bundle Identifier.
- You restarted Xcode after installation.
- If issues persist, check logs for any error messages or additional information.
If you require further assistance, feel free to contact us through our support channels or reach out on Discord. Don’t forget to explore our resources for more help! For more insights, updates, or to collaborate on AI development projects, stay connected with fxis.ai.
At fxis.ai, we believe that such advancements are crucial for the future of AI, as they enable more comprehensive and effective solutions. Our team is continually exploring new methodologies to push the envelope in artificial intelligence, ensuring that our clients benefit from the latest technological innovations.
