{"id":50296415,"url":"https://github.com/ideepakchauhan7/xerolas","last_synced_at":"2026-05-28T09:00:48.733Z","repository":{"id":355824630,"uuid":"1217836095","full_name":"ideepakchauhan7/Xerolas","owner":"ideepakchauhan7","description":"AI powered screen intelligence for your entire desktop — select any region from any app or window and get instant AI analysis on Windows, macOS \u0026 Linux.","archived":false,"fork":false,"pushed_at":"2026-05-27T19:11:03.000Z","size":11382,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-27T19:22:34.721Z","etag":null,"topics":["ai","capture","cross-platform","desktop-app","developer-tools","electron","electron-app","linux","macos","productivity","screen","windows"],"latest_commit_sha":null,"homepage":"https://xerolas.vercel.app","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/ideepakchauhan7.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-04-22T09:09:31.000Z","updated_at":"2026-05-27T19:09:45.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/ideepakchauhan7/Xerolas","commit_stats":null,"previous_names":["ideepakchauhan7/xerolas"],"tags_count":31,"template":false,"template_full_name":null,"purl":"pkg:github/ideepakchauhan7/Xerolas","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ideepakchauhan7%2FXerolas","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ideepakchauhan7%2FXerolas/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ideepakchauhan7%2FXerolas/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ideepakchauhan7%2FXerolas/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ideepakchauhan7","download_url":"https://codeload.github.com/ideepakchauhan7/Xerolas/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ideepakchauhan7%2FXerolas/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33601380,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-28T02:00:06.440Z","response_time":99,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["ai","capture","cross-platform","desktop-app","developer-tools","electron","electron-app","linux","macos","productivity","screen","windows"],"created_at":"2026-05-28T09:00:25.536Z","updated_at":"2026-05-28T09:00:48.715Z","avatar_url":"https://github.com/ideepakchauhan7.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n# Xerolas\n\n### See anything. Understand everything.\n\nDesktop-wide AI screen intelligence for Windows, macOS, and Linux.\n\n[Website](https://xerolas.vercel.app) · [Download](https://github.com/ideepakchauhan7/Xerolas/releases) · [Report issue](https://github.com/ideepakchauhan7/Xerolas/issues/new?template=bug_report.yml) · [Request feature](https://github.com/ideepakchauhan7/Xerolas/issues/new?template=feature_request.yml) · [License](./LICENSE)\n\n![Xerolas demo](./docs/assets/xerolas-demo.gif)\n\n\u003c/div\u003e\n\n## What Is Xerolas?\n\nXerolas is an open-source Electron desktop app that works like an AI lens for your whole operating system. Press the hotkey, drag over any screen region, and get an answer in a floating result panel beside the capture.\n\nIt is built for the moments where copying text is awkward, switching to a browser breaks flow, or the thing you need help with is already visible on your screen.\n\n## Features\n\n- Capture any screen region from any app with a global hotkey.\n- Get AI overview answers beside the selected capture.\n- Extract text from screenshots, documents, UI, and images.\n- Explain code snippets, errors, stack traces, and technical screens.\n- Translate captured text into your saved target language.\n- Summarize dense pages, PDFs, docs, notes, and articles.\n- Ask follow-up questions about the current capture without taking another screenshot.\n- Optionally enable provider-native or Xerolas Cloud web-aware answers when current context and source links help.\n\n## Download\n\nInstallers and update metadata are published through GitHub Releases:\n\nhttps://github.com/ideepakchauhan7/Xerolas/releases\n\nRecommended public install paths:\n\n- Windows: download the `.exe` installer.\n- macOS: download the `.dmg`.\n- Ubuntu/Linux: use the Snap/App Center build when available.\n- Linux manual installs: use `.AppImage` for portable use or `.deb` if you specifically need Debian packaging.\n\nThe public site is available at:\n\nhttps://xerolas.vercel.app\n\n## Access Modes\n\nXerolas is BYOK-first. The open-source desktop app does not commit, package, or expose Xerolas-owned provider keys.\n\nThere are two supported access modes:\n\n- Bring Your Own Key: the desktop app calls the selected provider directly with your locally saved key.\n- Xerolas Cloud: optional platform-key mode for users who receive an `xlo_live_...` key from Xerolas. The desktop app sends captures to a hosted gateway, and the gateway uses managed AI providers with server-side quotas and abuse controls.\n\nSupported providers:\n\n- Anthropic\n- OpenAI\n- Gemini\n- OpenRouter\n- Xerolas Cloud\n\nOpen Settings in the app, choose a provider, and save your key. Keys are stored outside normal settings using Electron OS encryption when available. The renderer only receives redacted key status, never the full saved key.\n\nFor `Xerolas Cloud`, the app stores only the opaque platform key locally. Real managed-provider credentials live only in the hosted gateway environment and are never part of the desktop repo or client bundle.\n\nOptional settings:\n\n- Model override for advanced BYOK users.\n- Explicit fallback providers between BYOK providers for retryable capacity or network failures.\n- Web search toggle for provider-native search when supported.\n- Translate target language.\n- Global capture hotkey.\n\n## Privacy And Security\n\n- In BYOK mode, screenshots are sent directly to the AI provider you select.\n- In Xerolas Cloud mode, screenshots are sent to the Xerolas Cloud gateway and processed by managed AI providers.\n- No Xerolas-owned AI key is committed, packaged, or exposed in the desktop app.\n- Provider and platform keys are never returned to the renderer after saving.\n- Invalid keys, billing errors, auth failures, and bad requests do not silently fallback to another provider or to Xerolas Cloud.\n- Xerolas does not add silent desktop telemetry. Feedback is handled through GitHub issues.\n\nIf OS encryption is unavailable in a production build, Xerolas refuses to persist provider keys. Development plaintext storage is available only with `XEROLAS_ALLOW_PLAINTEXT_KEYS=1`.\n\n## Development\n\nRequirements:\n\n- Node.js 20+\n- npm\n\nInstall dependencies:\n\n```bash\nnpm install\n```\n\nRun the desktop app in development:\n\n```bash\nnpm run dev\n```\n\nTypecheck:\n\n```bash\nnpm run typecheck\n```\n\nBuild:\n\n```bash\nnpm run build\n```\n\nOptional Xerolas Cloud builds can set `XEROLAS_CLOUD_GATEWAY_BASE_URL` or add `xerolasCloudGatewayBaseUrl` to `config/app-config.local.json`. The value should point to a separately hosted gateway that implements `/v1/key/status` and `/v1/analyze/stream`.\n\nExpected Xerolas Cloud gateway contract:\n\n- `GET /v1/key/status`: validate the `Authorization: Bearer xlo_live_...` platform key and return redacted key status plus remaining quota.\n- `POST /v1/analyze/stream`: validate the platform key, enforce quota/rate limits, call managed AI providers with server-side secrets, and stream normalized answer/search/source events back to the desktop app.\n- `POST /v1/keys`: issue or revoke platform keys from the Xerolas site or admin flow. Store only hashed platform keys server-side.\n\nThe repository is intentionally focused on the desktop app. The landing page is managed separately as a local-only ignored folder. Xerolas Cloud is an optional separately hosted gateway; keep its managed provider secrets outside this repo and outside client bundles.\n\n## Releases\n\nCreate a version tag such as `v0.1.30` and let the GitHub release workflow build the public artifacts:\n\n- Windows `.exe`\n- macOS `.dmg`\n- Linux `.snap`\n- Linux `.AppImage`\n- Linux `.deb`\n- updater metadata for `electron-updater`\n\nThe packaged app is configured to read update metadata from the main public `ideepakchauhan7/Xerolas` release feed.\n\n## Contributing And Feedback\n\nUseful feedback is very welcome:\n\n- [Report a bug](https://github.com/ideepakchauhan7/Xerolas/issues/new?template=bug_report.yml)\n- [Request a feature](https://github.com/ideepakchauhan7/Xerolas/issues/new?template=feature_request.yml)\n- [Share uninstall feedback](https://github.com/ideepakchauhan7/Xerolas/issues/new?template=uninstall_feedback.yml)\n\nWhen reporting capture or provider issues, include your OS, Xerolas version, install type, selected provider, and the exact error message. Do not include API keys or private screenshots.\n\n## License\n\nXerolas is released under the [MIT License](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fideepakchauhan7%2Fxerolas","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fideepakchauhan7%2Fxerolas","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fideepakchauhan7%2Fxerolas/lists"}