{"id":31684923,"url":"https://github.com/darksworm/traefiktop","last_synced_at":"2025-10-08T08:58:34.074Z","repository":{"id":312084229,"uuid":"1046265716","full_name":"darksworm/traefiktop","owner":"darksworm","description":"CLI tool to view the status of traefik routers and services","archived":false,"fork":false,"pushed_at":"2025-09-04T18:42:15.000Z","size":75648,"stargazers_count":17,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-21T06:46:50.087Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rust","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/darksworm.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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}},"created_at":"2025-08-28T12:39:01.000Z","updated_at":"2025-09-09T17:21:28.000Z","dependencies_parsed_at":"2025-08-28T19:06:08.274Z","dependency_job_id":"de4dd2bc-b8e3-4eb7-88ef-6630811968b6","html_url":"https://github.com/darksworm/traefiktop","commit_stats":null,"previous_names":["darksworm/traefiktop"],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/darksworm/traefiktop","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darksworm%2Ftraefiktop","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darksworm%2Ftraefiktop/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darksworm%2Ftraefiktop/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darksworm%2Ftraefiktop/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/darksworm","download_url":"https://codeload.github.com/darksworm/traefiktop/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darksworm%2Ftraefiktop/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278916428,"owners_count":26068091,"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-10-08T02:00:06.501Z","response_time":56,"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":[],"created_at":"2025-10-08T08:58:31.335Z","updated_at":"2025-10-08T08:58:34.066Z","avatar_url":"https://github.com/darksworm.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv\u003e\n\u003cpicture\u003e\n  \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"assets/logo-dark.svg\"\u003e\n  \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"assets/logo-light.svg\"\u003e\n  \u003cimg alt=\"traefiktop\" src=\"assets/logo-light.svg\"\u003e\n\u003c/picture\u003e\n \n[![GitHub Downloads](https://img.shields.io/github/downloads/darksworm/traefiktop/total?style=flat-square\u0026label=github+downloads)](https://github.com/darksworm/traefiktop/releases/latest)\n[![Latest Release](https://img.shields.io/github/v/release/darksworm/traefiktop?style=flat-square)](https://github.com/darksworm/traefiktop/releases/latest)\n[![License](https://img.shields.io/github/license/darksworm/traefiktop?style=flat-square)](./LICENSE)\n[![codecov](https://img.shields.io/codecov/c/github/darksworm/traefiktop?style=flat-square)](https://codecov.io/github/darksworm/traefiktop)\n\u003c/div\u003e\n\nA fast, keyboard‑friendly terminal UI for exploring Traefik routers and services. Rewritten in Rust using Ratatui for improved performance and resource efficiency.\n\n## 🚀 **Major Update: Now Written in Rust!**\n\n**v2.0 Migration**: This version represents a complete rewrite from TypeScript/Node.js to Rust. The CLI interface remains identical, but you'll benefit from:\n\n- **🔥 Faster startup** and lower memory usage\n- **⚡ Better performance** for large Traefik deployments  \n- **📦 Single binary** - no Node.js runtime required\n- **🎯 Same familiar interface** and keyboard shortcuts\n\n\u003e **Migration Note**: The npm package is deprecated as of v2.0. Please use the native binaries instead.\n\n## 🚀 Installation methods\n\n\u003cdetails\u003e\n  \u003csummary\u003e\u003cstrong\u003eInstall Script (Linux/macOS)\u003c/strong\u003e\u003c/summary\u003e\n\n```bash\ncurl -sSL https://raw.githubusercontent.com/darksworm/traefiktop/main/install.sh | sh\n```\n\nThe install script automatically detects your system (including musl vs glibc on Linux) and downloads the appropriate binary from the latest release.\n\nYou can also install a specific version:\n```bash\ncurl -sSL https://raw.githubusercontent.com/darksworm/traefiktop/main/install.sh | sh -s -- v0.1.0\n```\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e\u003cstrong\u003eDocker (Linux/macOS)\u003c/strong\u003e\u003c/summary\u003e\n\nPull and run the prebuilt image from GHCR:\n\n```bash\ndocker run --rm -it ghcr.io/darksworm/traefiktop:latest \\\n  --host https://traefik.example.org\n```\n\nFor self-signed endpoints, add `--insecure`. To reach a Traefik container, attach to its network:\n\n```bash\ndocker run --rm -it --network \u003ctraefik_net\u003e ghcr.io/darksworm/traefiktop:latest \\\n  --host http://traefik:8080\n```\n\nBuild locally instead of pulling:\n\n```bash\nbun run docker:build\nbun run docker:run -- --host https://traefik.example.org\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e\u003cstrong\u003enpm (DEPRECATED as of v2.0)\u003c/strong\u003e\u003c/summary\u003e\n\n\u003e ⚠️ **Deprecated**: The npm package is no longer maintained as of v2.0. Please use the native binaries instead for better performance.\n\n```bash\n# Last TypeScript version (v1.x)\nnpm i --global traefiktop@1\n```\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e\u003cstrong\u003eHomebrew (Linux/macOS)\u003c/strong\u003e\u003c/summary\u003e\n\n```bash\nbrew tap darksworm/homebrew-tap\nbrew install --cask traefiktop\n```\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e\u003cstrong\u003eAUR (Arch User Repository)\u003c/strong\u003e\u003c/summary\u003e\n\n```bash\nyay -S traefiktop-bin\n```\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003e\u003cstrong\u003eDownload a binary\u003c/strong\u003e\u003c/summary\u003e\n\nGrab binaries and packages from the latest release:\nhttps://github.com/darksworm/traefiktop/releases/latest\n\n\u003c/details\u003e\n\n## Screenshot\n\n\u003c!-- Replace with a real TUI screenshot or GIF --\u003e\n![traefiktop screenshot](assets/screenshot.png)\n\n## What it shows\n- Routers, their rules, and the services they target\n- Which router is effectively down (no healthy services)\n- The active service path (failover aware)\n- Quick, readable status with a minimal set of emojis and colors\n\n## Usage\n`--host` is required. Optionally hide routers by name with `--ignore` patterns (case‑insensitive). Use `*` at the start/end for “starts with” / “ends with”. Use `--insecure` to disable TLS verification for development against self‑signed endpoints.\n\n```bash\ntraefiktop --host https://traefik.example.org \\\n  --ignore staging-* \\\n  --ignore *-tmp,*-old\n```\n\nDevelopment only (self-signed endpoints):\n\n```\ntraefiktop --host https://selfsigned.local --insecure\n```\n\n## Keys\n- Navigation: `j/k` or arrows\n- Page: `PgDn/PgUp`, `Ctrl+f/Ctrl+b`\n- Jump: `gg` (top), `G` (bottom), `Home/End`\n- Search: `/` to filter, `Esc` to clear\n- Sort: `s` toggles (dead first/name); `d` dead first; `n` name\n- Quit: `q` or `Ctrl+C`\n\n## Build from source\nPrereqs: Rust ≥ 1.70\n\n```bash\n# Build release binary\ncargo build --release\n\n# The binary will be available at target/release/traefiktop\n./target/release/traefiktop --help\n```\n\n## Docker\n- Prebuilt images are published for releases to `ghcr.io/darksworm/traefiktop`.\n- Local builds work cross‑platform via a multi‑stage Dockerfile.\n\nPull and run (interactive TTY):\n\n```bash\ndocker run --rm -it ghcr.io/darksworm/traefiktop:latest \\\n  --host https://traefik.example.org\n```\n\nBuild locally and run:\n\n```bash\n# Build multi-arch image\ndocker buildx build --platform linux/amd64,linux/arm64 -t traefiktop:dev .\n\n# Run (pass CLI flags after image name)\ndocker run --rm -it traefiktop:dev --host https://traefik.example.org\n```\n\nSingle-arch build:\n\n```bash\ndocker build -t traefiktop:dev .\n```\n\n## Notes\n- API URL is mandatory. The app won’t start without `--host`.\n- Ignore patterns support: `foo*` (starts with), `*bar` (ends with), `*mid*` (contains). Pass multiple `--ignore` flags or comma‑separate values.\n- When selected, dead routers use a bright red background for better contrast. Active services are colored; inactive/down are grey.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdarksworm%2Ftraefiktop","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdarksworm%2Ftraefiktop","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdarksworm%2Ftraefiktop/lists"}