{"id":26033124,"url":"https://github.com/signerlabs/klee","last_synced_at":"2025-10-18T08:52:36.943Z","repository":{"id":280382008,"uuid":"939749593","full_name":"signerlabs/Klee","owner":"signerlabs","description":"Secure and local AI on your desktop with a built-in RAG knowledge base and Markdown note support.","archived":false,"fork":false,"pushed_at":"2025-03-17T09:17:18.000Z","size":17573,"stargazers_count":1527,"open_issues_count":16,"forks_count":118,"subscribers_count":10,"default_branch":"main","last_synced_at":"2025-04-11T06:16:23.897Z","etag":null,"topics":["app","klee","llamaindex","markdown","ollama","rag","self-hosted","ui"],"latest_commit_sha":null,"homepage":"https://kleedesktop.com/","language":"TypeScript","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/signerlabs.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":"2025-02-27T03:34:31.000Z","updated_at":"2025-04-10T15:34:58.000Z","dependencies_parsed_at":"2025-03-05T10:34:11.280Z","dependency_job_id":"be6af336-bbd2-419c-91f3-8646059464f4","html_url":"https://github.com/signerlabs/Klee","commit_stats":null,"previous_names":["signerlabs/klee-client","signerlabs/klee"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/signerlabs%2FKlee","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/signerlabs%2FKlee/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/signerlabs%2FKlee/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/signerlabs%2FKlee/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/signerlabs","download_url":"https://codeload.github.com/signerlabs/Klee/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248351394,"owners_count":21089272,"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":["app","klee","llamaindex","markdown","ollama","rag","self-hosted","ui"],"created_at":"2025-03-06T23:09:13.954Z","updated_at":"2025-10-18T08:52:31.892Z","avatar_url":"https://github.com/signerlabs.png","language":"TypeScript","funding_links":[],"categories":["A01_文本生成_文本对话"],"sub_categories":["大语言对话模型及数据"],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com/signerlabs/klee-client/releases\"\u003e\n    \u003cimg src=\"public/favicon.ico\" width=\"150\" height=\"150\" alt=\"banner\" /\u003e\u003cbr\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n# Klee\nKlee brings secure and local AI to your desktop with built-in RAG knowledge base and Markdown note. You can use local mode without any internet connection to protect your privacy.\n\nYou can download the latest version from our [Website](https://kleedesktop.com/) or join our [Discord](https://discord.gg/ZwMbWtVuNS) if you need any support.\n\nAt its core, Klee is built on:\n- \u003cu\u003e[Ollama](https://ollama.com/)\u003c/u\u003e: For running local LLMs quickly and efficiently.\n- \u003cu\u003e[LlamaIndex](https://www.llamaindex.ai/)\u003c/u\u003e: As the data framework.\n\n## 🌠 Demo\n\n\u003cimg src=\"public/kleedemo.GIF\" alt=\"Klee Demo\" style=\"border-radius: 8px\"\u003e\n\n## 🤝 Contributing\nWe warmly welcome contributions to Klee! Here are some ways you can get involved:\n\n1. Contribute Code: Develop new features or enhance existing code.\n2. Fix Bugs: Submit solutions for any bugs you encounter.\n3. Maintain Issues: Assist in managing GitHub issues.\n4. Product Design: Take part in design discussions.\n5. Write Documentation: Enhance user manuals and guides.\n6. Community Engagement: Participate in discussions and support users.\n7. Promote Usage: Help spread the word about Klee.\n\n## 🔧 Installation\n\nYou can download the [released version here](https://github.com/signerlabs/klee-client/releases) or you can setup following the processes below:\n\n### 1. System Requirements\n\n- Node.js 20.x or higher\n- Yarn 1.22.19 or higher\n\n### 2. Clone the Repository\n\n```bash\ngit clone https://github.com/signerlabs/klee-client.git\ncd klee-client\n```\n\n### 3. Install Dependencies\n\n```bash\nyarn install\n```\n\n### 4. Configure Environment Variables\n\nCopy the `.env.example` file to `.env`:\n\n```bash\ncp .env.example .env\n```\n\nEdit the `.env` file to configure the following environment variables according to your requirements:\n\n#### Basic Configuration\n\n```\n# Remote Mode Configuration\n# Set to 'true' to enable remote mode, 'false' to use local mode (default is 'false')\nVITE_USE_SUPABASE=false\n\n# Supabase configuration (only required if VITE_USE_SUPABASE=true)\n# These are used to configure your own remote service\n# If not specified, the system will use our default deployed service\nVITE_SUPABASE_ANON_KEY=your_supabase_anon_key\nVITE_SUPABASE_URL=your_supabase_url\nVITE_SUPABASE_AUTH_CALLBACK_URL=your_callback_url\n\n# Ollama service address (default: http://localhost:11434)\nVITE_OLLAMA_BASE_URL=http://localhost:11434\n\n# Local Python service address (default: http://localhost:6190)\nVITE_REQUEST_PREFIX_URL=http://localhost:6190\n```\n\n### 5. Set Up Backend Service\n\nBefore running the client, you need to set up and start the backend service. Clone and configure the backend service repository:\n\n```bash\ngit clone https://github.com/signerlabs/klee-service.git\ncd klee-service\n```\n\nFollow the installation instructions in the backend repository to set up and start the service. The backend service needs to be running on port 6190 (or the port you specified in `VITE_REQUEST_PREFIX_URL`) for the client to connect properly.\n\nRefer to the [klee-service repository](https://github.com/signerlabs/klee-service) for detailed backend setup instructions.\n\n### 6. Run in Development Mode\n\n```bash\nyarn dev\n```\n\nThis command will start both the Vite development server and the Electron application.\n\n### 7. Build the Application - Optional\n\n\n```bash\nyarn build\n```\n\n\n### 8. macOS App Signing and Notarization - Optional\n\nEdit `.env` file if you need to build a signed application for macOS.\n\n```\n# Apple ID account\nAPPLEID=your_apple_id@example.com\n# Apple ID password or app-specific password\nAPPLEIDPASS=your_apple_id_password\n# Apple Developer Team ID\nAPPLETEAMID=your_team_id\n```\n\nAfter building is complete, you can find the compiled application in the `dist` directory.\n\n## 🚀 Other Useful Commands\n\n- `yarn type-check`: Run TypeScript type checking\n- `yarn lint`: Run ESLint and Stylelint for code quality checking\n- `yarn lint:fix`: Automatically fix resolvable code style issues\n- `yarn generate-icons`: Generate application icons (requires app-icon.png file)\n\n## 📖 Technology Stack\n\n\u003cu\u003e[Electron](https://www.electronjs.org/)\u003c/u\u003e | \u003cu\u003e[React](https://react.dev/)\u003c/u\u003e | \u003cu\u003e[TypeScript](https://www.typescriptlang.org/)\u003c/u\u003e | \u003cu\u003e[Vite](https://vite.dev/)\u003c/u\u003e | \u003cu\u003e[Tailwind CSS](https://tailwindcss.com/)\u003c/u\u003e | \u003cu\u003e[Radix UI](https://www.radix-ui.com/)\u003c/u\u003e | \u003cu\u003e[i18nex](https://www.i18next.com/)\u003c/u\u003e | \u003cu\u003e[React Query](https://github.com/TanStack/query/)\u003c/u\u003e | \u003cu\u003e[Jotai](https://jotai.org/)\u003c/u\u003e","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsignerlabs%2Fklee","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsignerlabs%2Fklee","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsignerlabs%2Fklee/lists"}