{"id":13585003,"url":"https://github.com/neokd/NeoGPT","last_synced_at":"2025-04-07T06:32:15.654Z","repository":{"id":197607207,"uuid":"698905646","full_name":"neokd/NeoGPT","owner":"neokd","description":"Chat effortlessly, execute commands, and interpret code with Llama3, Phi3, and more - your local AI assistant. Enjoy seamless interaction while ensuring ultimate privacy","archived":false,"fork":false,"pushed_at":"2024-06-30T10:46:39.000Z","size":135145,"stargazers_count":78,"open_issues_count":0,"forks_count":64,"subscribers_count":4,"default_branch":"v0.2","last_synced_at":"2024-10-29T23:55:04.432Z","etag":null,"topics":["chatgpt","llama3","mistral","ollama","phi3","python"],"latest_commit_sha":null,"homepage":"https://neogpt.dev","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/neokd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-10-01T10:45:29.000Z","updated_at":"2024-10-01T18:52:49.000Z","dependencies_parsed_at":"2023-10-11T08:16:44.962Z","dependency_job_id":"5648728a-afb5-4181-ae73-7678f7c61e12","html_url":"https://github.com/neokd/NeoGPT","commit_stats":{"total_commits":283,"total_committers":37,"mean_commits":7.648648648648648,"dds":0.5865724381625441,"last_synced_commit":"757ef7b931f712a1b0ca9175abb8b19727aca6bd"},"previous_names":["neokd/neogpt"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neokd%2FNeoGPT","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neokd%2FNeoGPT/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neokd%2FNeoGPT/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neokd%2FNeoGPT/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/neokd","download_url":"https://codeload.github.com/neokd/NeoGPT/tar.gz/refs/heads/v0.2","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247607262,"owners_count":20965942,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chatgpt","llama3","mistral","ollama","phi3","python"],"created_at":"2024-08-01T15:04:39.982Z","updated_at":"2025-04-07T06:32:15.640Z","avatar_url":"https://github.com/neokd.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003c!-- \u003cimg src=\"https://github.com/neokd/NeoGPT/assets/71772185/82d5c63d-81b5-4b45-95d4-53641016bfdc\" alt=\"NeoGPT Gif\" width=\"500\"/\u003e --\u003e\n  \n\u003ch1 style=\"font-size: 3em;\"\u003eNeoGPT 🚀\u003c/h1\u003e\n\n  [![GitHub license](https://img.shields.io/github/license/neokd/NeoGPT?style=flat-round\u0026color=blue\u0026logo=github)](https://github.com/neokd/NeoGPT/blob/main/LICENSE)\n[![GitHub issues](https://img.shields.io/github/issues/neokd/NeoGPT?style=flat-round\u0026color=green\u0026logo=github)](https://github.com/neokd/NeoGPT/issues)\n[![GitHub stars](https://img.shields.io/github/stars/neokd/NeoGPT?style=flat-round\u0026color=yellow\u0026logo=github)](https://github.com/neokd/NeoGPT/stargazers)\n[![GitHub forks](https://img.shields.io/github/forks/neokd/NeoGPT?style=flat-round\u0026color=orange\u0026logo=github)](https://github.com/neokd/NeoGPT/network)\n[![Google Collab](https://img.shields.io/badge/Colab-F9AB00?style=flat-round\u0026logo=googlecolab\u0026labelColor=525252)](https://colab.research.google.com/drive/1ngzHdvoHfbSXZaeW5dBA__W4oHGLTQhV?usp=sharing)\n\n\n\u003c/div\u003e\n\n\u003e Currently We are in the development phase and are in progress of removing langchain as a dependency from the existing codebase. We are also working on adding more features to the CLI .\n\n\u003cdiv align=\"center\"\u003e\n\n\u003cspan\u003e\n        \u003ca href=\"https://docs.neogpt.dev/introduction\"\u003eDocumentation\u003c/a\u003e\n        \u003cspan\u003e | \u003c/span\u003e\n        \u003ca href=\"https://discord.gg/qNqjsGuCTG\"\u003eDiscord\u003c/a\u003e\n\u003c/span\u003e\n\u003cdiv\u003e\n\u003cbr/\u003e\n\u003cimg src=\"https://github.com/neokd/NeoGPT/blob/f04841e9afbac5bf426aca3619cd86a464da4932/docs/assets/intro.png?raw=true\" alt=\"Intro Image\"/\u003e\n\u003c/div\u003e\n\u003c/div\u003e\n\u003cbr/\u003e\n\n```bash\npip install neogpt\n```\n\u003e Not working? Read our setup guide [here](https://docs.neogpt.dev/installation)\n\n```bash\n$ neogpt\n```\n\n# Introduction\nNeoGPT is an AI assistant that transforms your local workspace into a powerhouse of productivity from your CLI. With features like code interpretation, multi-RAG support, vision models, and LLM integration, NeoGPT redefines how you work and create. Join the revolution and experience a new era of efficiency with NeoGPT.\n\n\n\nNeoGPT is continuously evolving, and your feedback shapes its future. Join our [Discord community](https://discord.gg/qNqjsGuCTG) to stay up to date with the latest developments.\n\n\n# Table of Contents\n- [Getting Started](#getting-started)\n- [Features](#features)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Getting Started\n\n1. **Installation:** Clone this repository and install the necessary dependencies.\n\n\n    ```\n      git clone https://github.com/neokd/NeoGPT.git\n      cd NeoGPT/neogpt\n      pip install -r requirements.txt\n    ```\n\n2. **Building Database** Currently NeoGPT supports local files and Youtube videos. To build the database add your local files to the documents directory and URL in the `builder.url` file. Then run the builder script.\n\n    ```python\n       python main.py --build\n    ```\n    This will create a database file in the `neogpt/db` folder. You can also specify the database to use by using `--db` flag.\n    Supported databases are:\n    - `Chroma` (default)\n    - `FAISS`\n\n    Currently the database is built using 2 papers as reference:\n    - [Attention Is All You Need](https://arxiv.org/pdf/1706.03762.pdf)\n    - [HuggingGPT](https://arxiv.org/pdf/2303.17580.pdf)\n\n\n3. **Run NeoGPT:** Run the CLI to start using NeoGPT. Requires `Python v3.10`. You can use the `--help` flag to view the available commands and options.\n    ```bash\n    python main.py\n    ```\n    You can also use `--ui` flag to run the Streamlit UI.\n    ```bash\n    python main.py --ui\n    ```\n\n4. **Project Documentation:**\n    To view the project documentation, run the following command in your terminal or command prompt (Development ⚠️)\n    ```bash\n    cd docs\n    npm i mintlify\n    mintlify dev\n    ```\n    \n\n## Features\n\n- **Code Interpreter:**\n    Execute code seamlessly in your local environment with our Code Interpreter. Enjoy the convenience of real-time code execution, all within your personal workspace.\n\n- **Multi RAG Support:**\n    NeoGPT supports multiple RAG techniques, enabling you to choose the most suitable model for your needs. It includes local RAG, ensemble RAG, web RAG, and more. 🧠📚\n\n- **Vision:**\n   Explore a new dimension as NeoGPT supports vision models like bakllava and llava, enabling you to chat with images using Ollama. 🖼️👁️🧠\n\n- **LLM 🤖:**\n   NeoGPT supports multiple LLM models, allowing users to interact with a variety of language models. We support LlamaCpp, Ollama, LM Studio, OpenAI, and Togerther Ai. 🤖🧠📚\n\n\n## Quick Start\n\n```bash\npip install https://github.com/neokd/NeoGPT/releases/download/v0.1.0/neogpt-0.1.0-py3-none-any.whl\n```\n\n## Terminal\n\nAfter installing the package, you can run the CLI by typing the following command in your terminal.\n\n```bash\n$ neogpt\n```\n\n## Python\n\n```python\nfrom neogpt import db_retriever\n\nchain = db_retriever()\n\nchain.invoke(\"What operating system are we on?\")\n```\n\n## Commands\n\n\n### Code Interpreter\nTo use the Interpreter, type the following command in your terminal.\n\n```bash\n$ neogpt --interpreter\n```\n\n### Build Vector Database\nTo build the vector database, type the following command in your terminal.\n\n```bash\n$ neogpt --build\n```\n\n### Run Streamlit UI\nTo run the Streamlit UI, type the following command in your terminal.\n\n```bash\n$ neogpt --ui\n```\n\n### Change Your LLM\n\n#### Offline LLM\n\nTo change your LLM, type the following command in your terminal.\n\n```bash\n$ neogpt --model ollama/bakllava\n```\n#### Online LLM\n\nTo change your LLM, type the following command in your terminal.\n\n\u003e Warning: Add your API key to the `.env` file before running the command.\n\n```bash\n$ neogpt --model together/mistralai/Mistral-7B-Instruct-v0.2\n```\n\n## Magic Commands\n\n\n- 🔄 `/reset` - Reset the chat session\n- 🚪 `/exit` - Exit the chat session\n- 📜 `/history` - Print the chat history\n- 💾 `/save` - Save the chat history to a `neogpt/conversations`\n- 📋 `/copy` - Copy the last response from NeoGPT to the clipboard\n- ⏪ `/undo` - Remove the last response from the chat history\n- 🔁 `/redo` - Resend the last human input to the model\n- 📂 `/load [path]` - Load the saved chat history from the specified file\n- 🔖 `/tokens [prompt]` - Calculate the number of tokens for a given prompt\n- 📄 `/export` - Export the current settings to the settings/settings.yaml file\n- 📜 `/conversations` - List available previously saved conversations.\n- 📚 `/source` - Prints the source directory\n- 🔍 `/search [keyword]` - Search the chat history for the keyword\n- 📋 `/copycode` or `/cc` - Copy the last code block to the clipboard\n\n\n## Contributing\nWe welcome contributions to NeoGPT! If you have ideas for new features or improvements, please open an issue or submit a pull request. For more information, see our [contributing guide](CONTRIBUTING.md).\n\n## License\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. Let's innovate together! 🤖✨\n\n\n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n \n   \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneokd%2FNeoGPT","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fneokd%2FNeoGPT","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneokd%2FNeoGPT/lists"}