{"id":15164732,"url":"https://github.com/rb81/docuchat","last_synced_at":"2026-01-21T20:36:03.646Z","repository":{"id":250671055,"uuid":"834772702","full_name":"rb81/docuchat","owner":"rb81","description":"A simple Terminal RAG app that only uses Ollama for total privacy.","archived":false,"fork":false,"pushed_at":"2024-10-16T20:38:18.000Z","size":1081,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-14T11:02:43.463Z","etag":null,"topics":["document-chat","llama","local-llm","ollama","privacy","rag","retrieval-augmented-generation"],"latest_commit_sha":null,"homepage":"","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/rb81.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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":"2024-07-28T10:11:25.000Z","updated_at":"2024-10-16T20:38:21.000Z","dependencies_parsed_at":"2024-09-13T22:40:50.411Z","dependency_job_id":"4e25a663-20ca-498b-82db-58666584e4b0","html_url":"https://github.com/rb81/docuchat","commit_stats":{"total_commits":5,"total_committers":1,"mean_commits":5.0,"dds":0.0,"last_synced_commit":"50562cdc7dec14934875984bf61dd4caba3883a0"},"previous_names":["rb81/docuchat"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rb81%2Fdocuchat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rb81%2Fdocuchat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rb81%2Fdocuchat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rb81%2Fdocuchat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rb81","download_url":"https://codeload.github.com/rb81/docuchat/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247865861,"owners_count":21009235,"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":["document-chat","llama","local-llm","ollama","privacy","rag","retrieval-augmented-generation"],"created_at":"2024-09-27T04:00:26.483Z","updated_at":"2026-01-21T20:36:03.562Z","avatar_url":"https://github.com/rb81.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DocuChat\n\n![DocuChat](/header.png)\n\nDocuChat is a simple Terminal RAG (Retrieval-Augmented Generation) application that allows you to talk to your files in complete privacy. Using Ollama, both the embedding and inference happens locally.\n\n## Features\n\n- **Document Processing**: Automatically processes PDF, TXT, and DOCX files from multiple directories.\n- **Source Switching**: Quickly and easily switch source folders, or access all your sources together.\n- **Intelligent Indexing**: Creates and maintains an efficient index of document content for quick retrieval.\n- **Natural Language Queries**: Allows users to ask questions in natural language about the content of their documents.\n- **Citation Support**: Provides citations for information sources, linking responses directly to document pages.\n- **Conversation Tracking**: Saves transcripts of conversations for future reference.\n- **User-Friendly Interface**: Offers a clean, color-coded command-line interface for easy interaction.\n\n## Prerequisites\n\n- Python 3.8+\n- Ollama (for running the LLM locally)\n\n## Installation\n\n1. Clone the repository:\n   ```\n   git clone https://github.com/rb81/docuchat.git\n   cd docuchat\n   ```\n\n2. Install the required dependencies:\n   ```\n   pip install -r requirements.txt\n   ```\n\n3. Configure the application by modifying the `config.py` file with your settings.\n\n## Usage\n\n1. Ensure Ollama is running with your chosen model.\n2. Run the DocuChat application:\n   ```\n   python main.py\n   ```\n\n3. Start chatting! Ask questions about your documents, and DocuChat will provide answers with relevant citations.\n\n4. Type `/source` to switch the source folder anytime (must be configured in the `config.py` file).\n\n5. Type `/quit` to exit the application and save your conversation transcript.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Transparency Disclaimer\n\n[ai.collaboratedwith.me](https://ai.collaboratedwith.me) in creating this project.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frb81%2Fdocuchat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frb81%2Fdocuchat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frb81%2Fdocuchat/lists"}