{"id":13499484,"url":"https://github.com/jon4hz/fztea","last_synced_at":"2025-05-16T14:08:27.497Z","repository":{"id":50190424,"uuid":"518599161","full_name":"jon4hz/fztea","owner":"jon4hz","description":"🐬🧋  Remote control your flipper from the local terminal or over SSH","archived":false,"fork":false,"pushed_at":"2025-04-07T23:46:54.000Z","size":3743,"stargazers_count":351,"open_issues_count":3,"forks_count":11,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-04-12T12:53:13.556Z","etag":null,"topics":["bubbletea","flipper","flipper-zero","flipperzero","serial-communication","ssh","tui"],"latest_commit_sha":null,"homepage":"","language":"Go","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/jon4hz.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}},"created_at":"2022-07-27T20:14:18.000Z","updated_at":"2025-04-07T23:46:51.000Z","dependencies_parsed_at":"2024-01-13T09:36:04.891Z","dependency_job_id":"bb0efe3d-cb29-452c-8909-53dceb370e27","html_url":"https://github.com/jon4hz/fztea","commit_stats":null,"previous_names":["jon4hz/flipperzero-tea"],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jon4hz%2Ffztea","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jon4hz%2Ffztea/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jon4hz%2Ffztea/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jon4hz%2Ffztea/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jon4hz","download_url":"https://codeload.github.com/jon4hz/fztea/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254544146,"owners_count":22088807,"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":["bubbletea","flipper","flipper-zero","flipperzero","serial-communication","ssh","tui"],"created_at":"2024-07-31T22:00:33.578Z","updated_at":"2025-05-16T14:08:27.449Z","avatar_url":"https://github.com/jon4hz.png","language":"Go","funding_links":[],"categories":["Off-device \u0026 Debugging","Applications"],"sub_categories":["*Utility*","Utility","System Management"],"readme":"# 🐬🧋 Fztea\n[![lint](https://github.com/jon4hz/fztea/actions/workflows/lint.yml/badge.svg)](https://github.com/jon4hz/fztea/actions/workflows/lint.yml)\n[![goreleaser](https://github.com/jon4hz/fztea/actions/workflows/release.yml/badge.svg)](https://github.com/jon4hz/fztea/actions/workflows/release.yml)\n[![Go Report Card](https://goreportcard.com/badge/github.com/jon4hz/fztea)](https://goreportcard.com/report/github.com/jon4hz/fztea)\n[![Powered by Dolphines](https://img.shields.io/badge/Powered%20by-Dolphins-blue)](https://img.shields.io/badge/Powered%20by-Dolphins-blue)\n\nA [bubbletea](https://github.com/charmbracelet/bubbletea)-bubble and TUI to interact with your [flipper zero](https://flipperzero.one/).  \nThe flipper will be automatically detected, if multiple flippers are connected, the first one will be used.\n\n## 🚀 Installation\n```bash\n# using go directly\n$ go install github.com/jon4hz/fztea@latest\n\n# from aur (btw)\n$ yay -S fztea-bin\n\n# local pkg manager\n## debian / ubuntu\n$ dpkg -i fztea-v0.6.2-linux-amd64.deb\n\n## rhel / fedora / suse\n$ rpm -i fztea-v0.6.2-linux-amd64.rpm\n\n## alpine\n$ apk add --allow-untrusted fztea-v0.6.2-linux-amd64.apk\n\n# homebrew (macOS \u0026 linux)\n$ brew install jon4hz/homebrew-tap/fztea\n\n# windows\n# -\u003e I'm sure you'll figure something out :)\n```\n\n## ✨ Usage\n```bash\n# trying to autodetect that dolphin\n$ fztea\n\n# no flipper found automatically :(\n$ fztea -p /dev/ttyACM0\n```\n\n## ⚡️ SSH\nfztea also allows you to start an ssh server, serving the flipper zero ui over a remote connection.  \nWhy? - Why not!\n```bash\n# start the ssh server listening on localhost:2222 (default)\n$ fztea server -l 127.0.0.1:2222\n\n# connect to the server (from the same machine)\n$ ssh localhost -p 2222\n```\n\nBy default, `fztea` doesn't require any authentication but you can specify an `authorized_keys` file if you want to.\n\n```bash\n# use authorized_keys for authentication\n$ fztea server -l 127.0.0.1:2222 -k ~/.ssh/authorized_keys\n```\n\n## 📸 Screenshots\nYou can take a screenshot of the flipper using `ctrl+s` at any time. `Fztea` will store the screenshot in the working directoy, by default in a 1024x512px resolution.  \nThe size of the screenshot can be customized using the `--screenshot-resolution` flag. \n```\n$ fztea --screenshot-resolution=1920x1080\n```\n\n## ⌨️ Button Mapping\n| Key             | Flipper Event | Keypress Type\n|-----------------|---------------|--------------|\n| w, ↑            | up            | short        |\n| d, →            | right         | short        |\n| s, ↓            | down          | short        |\n| a, ←            | left          | short        |\n| o, enter, space | ok            | short        |\n| b, back, esc    | back          | short        |\n| W, shift + ↑    | up            | long         |\n| D, shift + →    | right         | long         |\n| S, shift + ↓    | down          | long         |\n| A, shift + ←    | left          | long         |\n| O               | ok            | long         |\n| B               | back          | long         |\n\n\n## 🌈 Custom colors \nYou can set custom fore- and background colors using the `--bg-color` and `--fg-color` flags.\n```\n$ fztea --bg-color=\"#8A0000\" --fg-color=\"#000000\"\n```\nResults in:\n\n![ColorScreenshot](/.github/assets/custom_colors.png)\n\n\n\n## 🎬 Demo\n\n### Local\n![LocalDemo](/.github/assets/demo.gif)\n### SSH\nhttps://user-images.githubusercontent.com/26183582/181772189-13d7aeaa-ac26-4701-8104-a71ed218539c.mp4\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjon4hz%2Ffztea","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjon4hz%2Ffztea","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjon4hz%2Ffztea/lists"}