https://github.com/samrawal/chatgpt-localfiles
Make local files accessible to ChatGPT
https://github.com/samrawal/chatgpt-localfiles
Last synced: 6 months ago
JSON representation
Make local files accessible to ChatGPT
- Host: GitHub
- URL: https://github.com/samrawal/chatgpt-localfiles
- Owner: samrawal
- License: mit
- Created: 2023-06-02T20:58:40.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-06-29T22:52:16.000Z (over 2 years ago)
- Last Synced: 2024-11-09T19:41:22.556Z (11 months ago)
- Language: Python
- Size: 2.33 MB
- Stars: 44
- Watchers: 3
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ChatGPT-repositories - chatgpt-localfiles - Make local files accessible to ChatGPT (Others)
README
# ChatGPT Local Files Plugin
This plugin makes your local files accessible to ChatGPT via local plugin; allowing you to ask questions and interact with files via chat. Features and use-cases:
- Point to the base directory of code, allowing ChatGPT to read your existing code and any changes you make throughout the chat
- In addition to text files/code, also supports extracting text from PDF and DOCX files.
The core idea is based on something implemented in [kesor's fantastic chatgpt-code-plugin](https://github.com/kesor/chatgpt-code-plugin). This is simply a less-specific version of that project, with support for reading any text-based (like code), PDF, or DOCX files.
You need Plugin Developer access for this.
# Setup
## 1. Clone the repository and install requirements
```
git clone git@github.com:samrawal/chatgpt-localfiles.git
cd chatgpt-localfiles
pip install -r requirements.txt
```
## 2. Launch the app:
- You can access via command-line or a GUI:
`python serve.py {path_to_your_base_directory}` OR `python gui.py`
- The GUI is currently macOS-only and comes with a GUI directory picker and taskbar icon when server is running.
## 3. Add the plugin to ChatGPT (only needs to be done once): *Note: you need Plugin Developer Access for this*
- Go to Plugins -> Develop your own plugin -> Type `localhost:9900`. *Make sure the app is running while you do this!*
## 4. Start a new chat, with the Local Files plugin enabled. ChatGPT should now have access to a list of your files and their contents.
