{"id":42914101,"url":"https://github.com/sharex/xerahs","last_synced_at":"2026-05-11T00:13:44.077Z","repository":{"id":331990594,"uuid":"1124421776","full_name":"ShareX/XerahS","owner":"ShareX","description":"XerahS (ShareX.Avalonia) is a cross platform reimagining of the ShareX user interface built with Avalonia. It targets modern UX modular architecture and long term maintainability while preserving core workflows speed and reliability. It provides a foundation for future desktop experiences on Windows macOS and Linux with consistent accessible design","archived":false,"fork":false,"pushed_at":"2026-02-15T06:14:17.000Z","size":27042,"stargazers_count":133,"open_issues_count":6,"forks_count":3,"subscribers_count":1,"default_branch":"develop","last_synced_at":"2026-02-15T06:54:00.565Z","etag":null,"topics":["avalonia","sharex","xerahs"],"latest_commit_sha":null,"homepage":"https://xerahs.com","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ShareX.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":"docs/ROADMAP.md","authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2025-12-29T01:59:54.000Z","updated_at":"2026-02-15T06:14:20.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/ShareX/XerahS","commit_stats":null,"previous_names":["sharex/sharex.avalonia","sharex/xerahs"],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/ShareX/XerahS","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShareX%2FXerahS","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShareX%2FXerahS/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShareX%2FXerahS/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShareX%2FXerahS/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ShareX","download_url":"https://codeload.github.com/ShareX/XerahS/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShareX%2FXerahS/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29569994,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-18T04:18:28.490Z","status":"ssl_error","status_checked_at":"2026-02-18T04:13:49.018Z","response_time":162,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["avalonia","sharex","xerahs"],"created_at":"2026-01-30T17:02:12.936Z","updated_at":"2026-05-11T00:13:44.063Z","avatar_url":"https://github.com/ShareX.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# XerahS\n\n[![XerahS Health](https://oss-health-monitor.vercel.app/api/badge/ShareX/XerahS)](https://github.com/volotat/OSS-Health-Monitor)\n\nA cross-platform port of the popular **ShareX** screen capture and file sharing tool, built with **Avalonia UI** and .NET 10.\n\n![ShareX Avalonia](https://xerahs.com/assets/Logo.png)\n*(Note: Project is in active development)*\n\n## ⚠️ About This Project\n\n**XerahS is developed using agentic coding workflows.** This project embraces AI-assisted development as a first-class engineering practice, leveraging tools like GitHub Copilot, Claude, and other AI agents to accelerate feature development, refactoring, and code quality improvements. The codebase is architected with bleeding-edge technologies (.NET 10, Avalonia 11.3+) and prioritizes patterns that maximize AI comprehension: strict nullability, exhaustive documentation, and standardized MVVM architecture.\n\n**XerahS is and will always be free**, just like ShareX, built out of passion, not for profit. It's developed entirely through agentic coding as a parallel project to ShareX, designed to align with different user preferences and values. You're welcome to give it a try or stick with whatever tool works best for you.\n\n**If agentic coding is not your style**, we encourage you to try the original [**ShareX**](https://github.com/ShareX/ShareX) for Windows, which is developed using traditional methods and has a mature, battle-tested codebase backed by years of community contributions.\n\n**Built by the community, for the community.** XerahS is a collaborative effort driven by passionate contributors who believe in open-source development. Every feature, every improvement, and every line of code represents a shared vision of making powerful screen capture tools accessible to everyone, everywhere.\n\nFor developers interested in AI-first development and cross-platform experimentation, XerahS offers a modern foundation built for the future of software engineering.\n\n## ✨ Key Features\n- **Cross-Platform Desktop**: Runs on Windows, Linux, and macOS (targeting).\n- **Mobile Support (Experimental)**: .NET MAUI implementation for **Android** and **iOS** with file upload, share extension, and uploader configuration.\n- **Modern UI**: Reimagined interface inspired by modern design principles.\n- **Powerful Capture**:\n    - **Region Capture**: supports multi-monitor setups with crosshair cursor.\n    - **Fullscreen** \u0026 **Window** capture modes.\n- **macOS Support (MVP)**:\n    - Screenshot service via native `screencapture`\n    - Global hotkeys powered by SharpHook (requires Accessibility permission)\n- **Advanced Annotation Tools**:\n    - **17 Annotation Types**: Rectangle, Ellipse, Line, Arrow, Text, Number/Step, Blur, Pixelate, Magnify, Highlight, Freehand, SpeechBalloon, Image/Sticker, Spotlight, SmartEraser, Crop, plus base types\n    - **Basic Shapes**: Rectangle, Ellipse, Line, Arrow, Text, Number/Step\n    - **Effect Shapes**: Blur, Pixelate, Magnify, Highlight with real-time preview\n    - **Freehand Tools**: Pen, Highlighter, Smart Eraser\n    - **Advanced Shapes**: Speech Balloon, Image/Sticker insertion, Spotlight\n    - **Object-based** selection, moving, resizing, and deletion\n    - **Full Undo/Redo** support\n    - **Keyboard Shortcuts**: V(Select), R(Rectangle), E(Ellipse), A(Arrow), L(Line), P(Pen), H(Highlighter), T(Text), B(Balloon), N(Number), C(Crop), M(Magnify), S(Spotlight), F(Effects)\n- **Workflows (Zero Inheritance)**:\n    - **Unique Settings**: Each workflow is fully independent with its own hotkeys and tasks.\n    - **No \"Default\" Inheritance**: Reduces configuration errors by avoiding complex inheritance chains.\n    - **Task Workflow**: Configurable after-capture tasks (Save, Copy, Upload, Image Effects)\n- **Modern Capture Architecture**:\n    - **Windows**: Uses fast `Desktop Duplication API` (DXGI) for high-performance capture.\n    - **macOS**: Leverages native `ScreenCaptureKit` for performant, permission-compliant recording.\n    - **Linux**: X11 and Wayland support.\n- **Image Editor**:\n    - **Hardware Accelerated**: Fully GPU-accelerated rendering using Skia/Metal/Direct2D. renders 4K+ images at 60FPS.\n    - **40+ Effects**: Organized into Adjustments, Filters, Manipulations, and Drawings.\n    - **Real-time Preview**: Apply effects with instant visual feedback.\n    - **Serialization**: Save and load annotations with full type support.\n\n## 📱 Mobile (Experimental)\n\nXerahS now includes an experimental **.NET MAUI** mobile implementation for Android and iOS, bringing ShareX's powerful upload capabilities to mobile devices.\n\n### Mobile Features\n- **File Upload**: Upload images, videos, and files from your device\n- **Share Extension (iOS)**: Share content directly from other apps into XerahS\n- **Uploader Support**: Configure Amazon S3 and Custom Uploaders\n- **Settings Sync**: Mobile-optimized settings interface\n\n### Building Mobile\n\n#### Prerequisites\n- [.NET 10.0 SDK](https://dotnet.microsoft.com/download/dotnet/10.0)\n- **Android**: Android SDK API 21+ with emulator or physical device\n- **iOS**: Xcode 16+ (macOS required), iOS 15.0+ target\n\n#### Build \u0026 Run\n```bash\n# Android\ndotnet build src/XerahS.Mobile.Maui/XerahS.Mobile.Maui.csproj -f net10.0-android\ndotnet run --project src/XerahS.Mobile.Maui/XerahS.Mobile.Maui.csproj -f net10.0-android\n\n# iOS (macOS only)\ndotnet build src/XerahS.Mobile.Maui/XerahS.Mobile.Maui.csproj -f net10.0-ios\ndotnet run --project src/XerahS.Mobile.Maui/XerahS.Mobile.Maui.csproj -f net10.0-ios\n```\n\n### Project Structure\n- `XerahS.Mobile.Maui` - Main MAUI application (Android/iOS)\n- `XerahS.Mobile.UI` - Shared mobile UI components\n- `XerahS.Mobile.Android` - Android-specific platform code\n- `XerahS.Mobile.iOS` - iOS-specific platform code\n- `XerahS.Mobile.iOS.ShareExtension` - iOS Share Extension for receiving shared content\n\n---\n\n## 🚀 Getting Started\n\n### Cloning the Repository\nXerahS requires the `ShareX.ImageEditor` and `ShareX.VideoEditor` submodules. Clone with:\n```bash\ngit clone --recursive https://github.com/ShareX/XerahS.git\n```\n\nIf you already cloned without `--recursive`, initialize the submodules:\n```bash\ncd XerahS\ngit submodule update --init --recursive\n```\n\n### Desktop Quick Start (Windows)\nOn Windows, the fastest verified first-run path is:\n```powershell\n.\\init-submodules.ps1\ndotnet build src/desktop/XerahS.sln -m:1 -p:nodeReuse=false -p:UseSharedCompilation=false\n```\n\nIf you skip submodule initialization and run `dotnet build src/desktop/XerahS.sln` immediately after a plain `git clone`, the build fails with `MSB3202` because `ShareX.ImageEditor` and `ShareX.VideoEditor` are checked out as Git submodules.\n\n### Prerequisites\n- [.NET 10.0 SDK](https://dotnet.microsoft.com/download/dotnet/10.0)\n- Node.js `^20.19.0 || \u003e=22.12.0` for the `ShareX.VideoEditor` frontend build\n\n### Arch Linux (AUR)\nArch Linux users can install the latest development version via the community-maintained AUR package [`xerahs-git`](https://aur.archlinux.org/packages/xerahs-git) (maintained by @unicxrn).\n\nThis package builds directly from the source code and automatically handles dependencies, including the .NET 10 SDK. It can be installed using an AUR helper like `yay`:\n```bash\nyay -S xerahs-git\n```\n\n### macOS Permissions (Screen Recording)\nScreen capture on macOS requires Screen Recording permission:\n1. Open **System Settings** \u003e **Privacy \u0026 Security** \u003e **Screen Recording**.\n2. Enable XerahS for screen capture access.\n3. Restart the app after granting permission.\n\n### macOS Permissions (Global Hotkeys)\nGlobal hotkeys use SharpHook and need Accessibility permission:\n1. Open **System Settings** \u003e **Privacy \u0026 Security** \u003e **Accessibility**.\n2. Enable XerahS (or the published app bundle) for accessibility access.\n3. Restart the app and retest hotkeys.\n\n### macOS Troubleshooting (\"App is damaged\")\nIf you see a message saying **\"XerahS is damaged and can't be opened\"**, it is due to macOS security (Gatekeeper) on quarantined downloads. To fix it:\n\n1. Open **Terminal**.\n2. Type the following command (do not hit Enter yet):\n   ```bash\n   xattr -cr \n   ```\n3. Drag the **XerahS.app** file from Finder into the Terminal window (this pastes the full path).\n4. Only now, press **Enter**.\n\n## 🛠️ Developer Information\n\nSee [XerahS Developer Guide](developers/README.md) for architecture details and contribution guidelines.\n\n## 📄 [License](LICENSE.txt)\n\n\n\n\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsharex%2Fxerahs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsharex%2Fxerahs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsharex%2Fxerahs/lists"}