{"id":32777997,"url":"https://github.com/scarletkc/glitter","last_synced_at":"2025-11-07T17:01:50.045Z","repository":{"id":321893776,"uuid":"1087491051","full_name":"scarletkc/glitter","owner":"scarletkc","description":"Glitter is a cross‑platform CLI for encrypted LAN file transfers. It auto‑discovers peers, confirms on receive, shows   progress/throughput, and supports i18n.","archived":false,"fork":false,"pushed_at":"2025-11-01T07:47:32.000Z","size":32,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-11-01T08:28:16.463Z","etag":null,"topics":["cli","diffie-hellman","encryption","file-transfer","internationalization","lan","linux","localsend-alternative","macos","multilingual","p2p","peer-discovery","python","sha256","tcp","udp-broadcast","windows","wsl2"],"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/scarletkc.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":"2025-11-01T02:45:39.000Z","updated_at":"2025-11-01T07:47:36.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/scarletkc/glitter","commit_stats":null,"previous_names":["scarletkc/glitter"],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/scarletkc/glitter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scarletkc%2Fglitter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scarletkc%2Fglitter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scarletkc%2Fglitter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scarletkc%2Fglitter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/scarletkc","download_url":"https://codeload.github.com/scarletkc/glitter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scarletkc%2Fglitter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":282825491,"owners_count":26733495,"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","status":"online","status_checked_at":"2025-11-05T02:00:05.946Z","response_time":58,"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":["cli","diffie-hellman","encryption","file-transfer","internationalization","lan","linux","localsend-alternative","macos","multilingual","p2p","peer-discovery","python","sha256","tcp","udp-broadcast","windows","wsl2"],"created_at":"2025-11-04T14:01:28.350Z","updated_at":"2025-11-07T17:01:50.028Z","avatar_url":"https://github.com/scarletkc.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n![Glitter](https://raw.githubusercontent.com/scarletkc/glitter/refs/heads/main/assets/glitter.svg)\n\n# Glitter — Simple File Transfer CLI\n\n[![PyPI](https://img.shields.io/pypi/v/glitter-cli.svg)](https://pypi.org/project/glitter-cli/)\n[![Python](https://img.shields.io/badge/python-3.9%2B-blue)](https://www.python.org/downloads/)\n[![License](https://img.shields.io/github/license/scarletkc/glitter.svg)](https://github.com/scarletkc/glitter/blob/main/LICENSE)\n\n**[English](https://github.com/scarletkc/glitter/blob/main/README.md)** | [中文](https://github.com/scarletkc/glitter/blob/main/docs/README.zh-CN.md)\n\n\u003c/div\u003e\n\n---\n\nGlitter is a cross‑platform, terminal‑based tool for sending files over a local network. It discovers peers automatically, confirms transfers on the receiver, and supports English/Chinese UIs.\n\n- OS support: Linux, macOS, Windows\n- Bilingual UI: English, 中文 (switchable in settings)\n- Peer discovery via UDP broadcast + smart replies (or manual IP entry)\n- Encrypted transfer (DH key exchange + stream cipher)\n- Device fingerprint verification (TOFU) to flag impersonation attempts\n- Integrity check (SHA-256) after receive\n- Directory transfer: send entire folders (auto-zipped, zero compression)\n- Transfer progress and live throughput (e.g. 1.2 MB/s)\n- Transfer history (JSONL) stored under user home\n- Settings for language \u0026 device name \u0026 encryption, clear history\n\n## Why Glitter?\n\nGlitter provides a **simple, terminal-based** alternative to GUI tools and complex protocols:\n\n| Tool | Pros | Cons | Glitter Advantage |\n|------|------|------|-------------------|\n| **LocalSend** | Beautiful GUI, cross-platform | Requires GUI environment, ~100MB+ install | **CLI-first**: works via SSH, lightweight (~50KB), scriptable |\n| **Magic Wormhole** | Simple one-time codes | Requires relay server, single-file only | **LAN-direct**: no internet needed, auto-discovery, no codes to type |\n| **SFTP/SCP** | Universal, encrypted | Needs SSH server setup, manual IP entry | **Zero-config**: auto-discovers peers, no server setup |\n| **rsync** | Powerful sync engine | Complex syntax, requires remote shell access | **Interactive**: menu-driven, progress bars, history tracking |\n| **HTTP file server** | Simple `python -m http.server` | No encryption, manual URL sharing | **Secure**: DH key exchange + encryption, peer selection UI |\n| **croc** | End-to-end encryption, relay servers, cross-platform | Requires typing codes, internet relay by default | **LAN-native**: auto-discovery on local network, no codes needed, works offline |\n\n**Use Glitter when you want:**\n- Quick file sharing on LAN without leaving the terminal\n- Auto-discovery instead of typing IPs\n- Encrypted transfers without complex SSH setup\n- Minimal dependencies (pure Python, no external binaries)\n- Transfer history and bilingual UI\n\n## Quick Start\n\nOn first run, Glitter asks for language and device name and saves them. Next runs go straight to the main menu.\n\n- Compilation: [binary](https://github.com/scarletkc/glitter/releases)\n- Firewall: Allow UDP 45845 and TCP 45846 (transfer port) for the app if discovery/transfer is blocked.\n\n### Installation\n\nRecommended to install and run via [pipx](https://pipx.pypa.io/stable/):\n\n- `apt install pipx`  # Debian/Ubuntu\n- `pipx install glitter-cli`\n- `glitter`\n  - `pipx upgrade glitter-cli`  # to update\n\n\u003cdetails\u003e\n  \u003csummary\u003eAlternative: install via pip (not recommended)\u003c/summary\u003e\n\n- `pip install glitter-cli`\n- `glitter`\n  - `pip install --upgrade glitter-cli`  # to update\n  \n\u003c/details\u003e\n\n### From source\n\nRequirements: install [deps](https://github.com/scarletkc/glitter/blob/main/requirements.txt)\n\n- Linux/macOS/WSL/Windows (PowerShell/CMD) Run: \n  - `git clone https://github.com/scarletkc/glitter.git`\n  - `pip install -r requirements.txt`\n  - `python3 -m glitter`\n   - `git pull` # to update\n\n## Usage\n\n- **`glitter`** — Launch the interactive menu (list peers, send/receive requests, view history, configure download/encryption/auto-accept modes, etc.).\n- `glitter send \u003cpeer|IP[:port]\u003e \u003cpath\u003e` — Send a file or directory directly without the menu (peer ID, device name, or manual IP).  \n- `glitter peers` — List peers currently discovered on the LAN.\n- `glitter history [--clear]` — Print recent transfer history records, or clear them instantly.\n- `glitter settings [--language CODE] [--device-name NAME] [--clear-trust]` — Jump straight into the settings menu or apply specific changes (language, device name, trust reset) in one go.\n- `glitter update` — Check the latest available Glitter version.\n- `glitter receive [--mode trusted|all] [--dir PATH] [--port PORT] [--no-encryption]` — Run in auto-receive mode (trusted/all) without opening the menu.\n\nTip: once the initial setup is complete, you can keep Glitter running headlessly with your favourite process manager (`uv run`, `systemd`, `pm2`, ...). \n\n## Files \u0026 Persistence\n\n- Config: `~/.glitter/config.json` (language, device name, transfer port, encryption, default receive directory, auto-accept mode)\n- Trusted fingerprints: `~/.glitter/known_peers.json` (peer IDs and fingerprints stored after first approval)\n- History: `~/.glitter/history.jsonl` (one JSON per line)\n- Default receive folder: configurable; defaults to `~/Downloads/GlitterDownloads` on Windows, `~/GlitterDownloads` elsewhere\n\n## Debugging\n\n- Enable verbose IDs in lists by setting env var `GLITTER_DEBUG=1` before launch.\n\n## License\n\n[MIT](https://github.com/scarletkc/glitter/blob/main/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscarletkc%2Fglitter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscarletkc%2Fglitter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscarletkc%2Fglitter/lists"}