{"id":17231942,"url":"https://github.com/eruvanos/retro-cli","last_synced_at":"2025-04-14T01:43:22.292Z","repository":{"id":65223280,"uuid":"304783028","full_name":"eruvanos/retro-cli","owner":"eruvanos","description":"A cli tool for distributed team retros(build in a few hours + a few more)","archived":false,"fork":false,"pushed_at":"2025-01-27T07:27:04.000Z","size":175,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-27T15:52:42.892Z","etag":null,"topics":["cli","python","retro","rpc","socket"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eruvanos.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2020-10-17T02:42:38.000Z","updated_at":"2025-01-27T07:27:01.000Z","dependencies_parsed_at":"2023-01-15T16:15:35.867Z","dependency_job_id":"b83fef67-0d32-4b48-8f7e-9af1485ee3ab","html_url":"https://github.com/eruvanos/retro-cli","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eruvanos%2Fretro-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eruvanos%2Fretro-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eruvanos%2Fretro-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eruvanos%2Fretro-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eruvanos","download_url":"https://codeload.github.com/eruvanos/retro-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248809044,"owners_count":21164895,"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":["cli","python","retro","rpc","socket"],"created_at":"2024-10-15T05:00:01.436Z","updated_at":"2025-04-14T01:43:22.272Z","avatar_url":"https://github.com/eruvanos.png","language":"Python","readme":"\u003e This is more like a POC. While the base features work, the user experience might be a little ruff.\n\u003e I might come back to reimplement this using [Textual](https://www.textualize.io/projects/#textual)\n\n# Retro on the commandline\n\nRetro-CLI uses ngrok to setup a local server and generate an invitation code for others to join.\nOnly the host needs an ngrok.com account.\n\n## Features\n\n* Host or join retro\n  * Add item in HAPPY, NEUTRAL, or BAD column\n  * Remove item\n  * Move item\n  * Mark item as done (strike through not visualized in Jetbrains IDEA terminals)\n* Connection via ngrox.com\n* End-to-End encryption\n\n\n\n![screenshot](screenshot.png)\n\n## Installation\n\n### Requires Python 3.8+\n\n```\nbrew install python\n# or even better, use pyenv\nbrew install pyenv\npyenv install 3.9.0\n```\n\n\n### Install cli\n\n```\npipx install git+https://github.com/eruvanos/retro-cli.git#egg=retro \n\n# or with pure pip\n\npip install git+https://github.com/eruvanos/retro-cli.git#egg=retro\n```\n\n\u003e This will also install ngrok on your path\n\n## Usage\n\n#### Start as host\n\nConfigure your NGrok auth token. (Register at https://ngrok.com to get it)\nStarts the storage backend and generates an invitation code, which is shown in the console.\n\n```\n\nngrok authtoken \u003cauth token\u003e\n\nretro -s\n\n# to only start the server, without the retro UI\nretro -so\n```\n\n#### Join a host\n\n\nStarts the app and asks for the invitation code of the host.\n\n```\nretro\n```\n\n\n#### Shortcuts\n\n* `CTRL + q` - Exit\n* `CTRL + r` - Request data from server (Refresh)\n* `CTRL + p` - Ping server and print latency\n\n#### Commands\n\n##### Add a new item\n\nYou cann add items to the retro board by typing in your text, tusing a prefix to assign the item to a column.\n\nPrefix:\n- `+` Happy\n- `.` Neutral \n- `-` Sad\n\n##### Move an item\n\n`mv \u003citem id\u003e \u003ccolumn prefix\u003e`\n\n##### Toggle item done-state\n\n`! \u003citem id\u003e`\n\n##### Remove an item\n\n`rm \u003citem id\u003e`\n\n## Missing\n\n- persist retro items on host, so a restart doesn't kill them\n- use [Textualize](https://github.com/Textualize/textual)\n  - bring mouse support\n- show help within the app\n- add tests!\n\n\n## Architecture\n\n```\n┌──────────────────────────────────────────────────┐  ┌──────────────────────────────────────────────────┐\n│                       App                        │  │                     Backend                      │\n│                                                  │  │                                                  │\n│┌───────────────────────────────────────────────┐ │  │┌────────────────────────────────────────────────┐│\n││                                               │ │  ││                                                ││\n││                prompt-toolkit                 │ │  ││                 InMemoryStore                  ││\n││                                               │ │  ││                                                ││\n│└───────────────────────────────────────────────┘ │  │└────────────────────────────────────────────────┘│\n│┌───────────────────────────────────────────────┐ │  │┌────────────────────────────────────────────────┐│\n││                                               │ │  ││                                                ││\n││                RPCStoreClient                 │ │  ││                   RPCHandler                   ││\n││                                               │ │  ││                                                ││\n│└───────────────────────────────────────────────┘ │  │└────────────────────────────────────────────────┘│\n│┌───────────────────────────────────────────────┐ │  │┌────────────────────────────────────────────────┐│\n││                 SecureNetwork                 │ │  ││                 SecureNetwork                  ││\n││            (use fernet encryption)            │ │  ││            (use fernet encryption)             ││\n││                                               │ │  ││                                                ││\n│└───────────────────────────────────────────────┘ │  │└────────────────────────────────────────────────┘│\n│┌───────────────────────────────────────────────┐ │  │┌────────────────────────────────────────────────┐│\n││                                               │ │  ││                                                ││\n││                  TCP socket                   │ │  ││                   TCP socket                   ││\n││                                               │ │  ││                                                ││\n│└───────────────────────────────────────────────┘ │  │└────────────────────────────────────────────────┘│\n│┌─────────────────────────────────────────────────┴──┴─────────────────────────────────────────────────┐│\n││                                                                                                      ││\n││                                               pyngrok                                                ││\n││                                                                                                      ││\n│└─────────────────────────────────────────────────┬──┬─────────────────────────────────────────────────┘│\n└──────────────────────────────────────────────────┘  └──────────────────────────────────────────────────┘\n\nCreated with Monodraw\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feruvanos%2Fretro-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feruvanos%2Fretro-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feruvanos%2Fretro-cli/lists"}