Carnal

🚧 : Carnal is currently in early development. Many features may not be fully functional.

Your Computer as a Knowledge Base Working Seamlessly with Language Models Like OpenAI's GPT.

Overview

Carnal is designed to leverage the power of Language Models (LLM) such as GPT from OpenAI to help users manage local files on their computer. With Carnal, you can read, modify, and delete local files and folders using natural language commands.

Currently tested on macOS, Carnal aims to provide support for Windows and Linux in the near future.

Motivation

Inspired by projects like Kaguya and Quivr, Carnal is designed to stay simple and accessible. It doesn't require extra dependencies like ChatGPT or Docker, making it frictionless for everyone to use. Just install the Carnal desktop app, and you're ready to explore a new way to interact with your files.

Features

• Read, Modify, and Delete Files: Manage your local files effortlessly with natural language commands.
• Cross-Platform Support: Though currently tested on macOS, Windows and Linux support is coming soon.
• No Extra Dependencies: Carnal is built with simplicity in mind, with no need for complex setups or extra tools.

Support

Having trouble? DM me at Twitter.

Getting Started

Installation

macOS

1. Navigate to the Carnal release page.
2. Find the latest release and download the .zip file for macOS.
3. After downloading, unzip the .zip file and drag the Carnal app into your Applications folder.
4. The first time you open Carnal, macOS may prevent it from running since it's downloaded from the internet. To bypass this:
   • Go to System Settings.
   • Go to Privacy & Security.
   • Under the Security section, click 'Open Anyway' next to the message about Carnal.

❗️ Remember: Always ensure you're downloading software from trusted sources. Given Carnal's capability to manage files on your computer, you must ensure you're using the official release from a trusted developer or build it yourself.

Development

To run Carnal in development mode, you can use the following command:

1. Rename .env.sample to .env.
2. Provide your own OpenAI API key in the .env file.
3. Run the following command:

flutter run -d macos

Or, if you're using VSCode, simply launch "Debug Carnal MacOS."

❗️ For macOS: App Sandbox is disabled because Carnal needs to access your local files. This means that Carnal will not be available on the App Store. If you're concerned about security, you can build Carnal from source.

Contribute

To contribute to this project, please follow a "fork and pull request" workflow.

The project follows Conventional Commits specification for commit messages. This allows us to automatically generate the changelog and release notes.

Credits

Carnal was inspired by the following projects:

• Kaguya
• Quivr
• Biyi

License

Carnal is licensed under the MIT License. Feel free to contribute, modify, and share.

---

Enjoy using Carnal? Star the repo to show your support!

Next steps

• Improve the ability to handle multiple files at the same times
• Full text search for memory
• Refactor Globs matching logic for ignored files
• Shift+Enter for new line when chatting
• Imporve ui when the agent is thinking
• macOS: App Icons bigger than normal
• Doc loaders
• UI: Avoid launch time resize
• UI: Window show position is wired