{"id":50873402,"url":"https://github.com/yamcodes/akin","last_synced_at":"2026-06-15T07:05:35.648Z","repository":{"id":341036269,"uuid":"1168656301","full_name":"yamcodes/akin","owner":"yamcodes","description":"Akinator in the terminal, no ads","archived":false,"fork":false,"pushed_at":"2026-02-28T16:07:02.000Z","size":281,"stargazers_count":1,"open_issues_count":3,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-02-28T16:16:38.094Z","etag":null,"topics":["akinator","cli","python"],"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/yamcodes.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-02-27T16:39:28.000Z","updated_at":"2026-02-28T16:07:05.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/yamcodes/akin","commit_stats":null,"previous_names":["yamcodes/akinator-cli","yamcodes/akin"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/yamcodes/akin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yamcodes%2Fakin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yamcodes%2Fakin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yamcodes%2Fakin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yamcodes%2Fakin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yamcodes","download_url":"https://codeload.github.com/yamcodes/akin/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yamcodes%2Fakin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34351466,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-15T02:00:07.085Z","response_time":63,"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":["akinator","cli","python"],"created_at":"2026-06-15T07:05:34.843Z","updated_at":"2026-06-15T07:05:35.643Z","avatar_url":"https://github.com/yamcodes.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# akin\n\n[![License](https://custom-icon-badges.demolab.com/github/license/yamcodes/akin?label=License\u0026color=blue\u0026logo=law\u0026labelColor=0d1117)](https://github.com/yamcodes/akin/blob/main/LICENSE)\n[![Python](https://img.shields.io/badge/Python-3-3776AB?logo=python\u0026logoColor=white)](https://python.org)\n[![uv](https://img.shields.io/badge/uv-261230?logo=uv\u0026logoColor=white)](https://docs.astral.sh/uv/)\n[![Docker](https://img.shields.io/badge/Docker-2496ED?logo=docker\u0026logoColor=white)](https://docker.com)\n[![Scalar](https://img.shields.io/badge/Scalar-080808?logo=scalar\u0026logoColor=e7e7e7)](https://scalar.com/)\n[![Star](https://custom-icon-badges.demolab.com/github/stars/yamcodes/akin?logo=star\u0026logoColor=373737\u0026label=Star)](https://github.com/yamcodes/akin/stargazers/)\n\nThe Akinator experience, simplified. No ads, no busy UI.\n\n![Phase 1 screenshot](./assets/phase1.png)\n\n## Prerequisites\n\n| Tool                                                      | Required for                |\n| --------------------------------------------------------- | --------------------------- |\n| [uv](https://docs.astral.sh/uv/)                          | all targets                 |\n| [Docker](https://docs.docker.com/get-started/get-docker/) | `make docker`, `make start` |\n| [curl](https://curl.se/)                                  | `make start`                |\n\n## Quick start\n\n```bash\nmake setup    # install deps + initialize both services (re-run after pulling dep changes)\n\nmake start                    # full stack: engine (Docker) + TUI\nmake start ARGS=\"es\"          # same, Spanish\nmake start ARGS=\"en --debug\"  # same, with debug info\n```\n\nOr run services separately:\n\n```bash\n# Dockerless (two terminals)\nmake engine     # Terminal 1 - engine on :8000\nmake tui        # Terminal 2 - TUI\n\n# Docker engine + native TUI (two terminals)\nmake docker     # Terminal 1 - engine via Docker Compose\nmake tui        # Terminal 2 - TUI\n```\n\nRun `make` (no target) to see all available targets.\n\nOnce the engine is running, the interactive API docs are at **http://localhost:8000**.\n\n## Architecture\n\nThe project is built in phases, each adding a layer while keeping the previous one intact as a reference.\n\n### Phase 0: Proof of concept\n\n[Single `main.py` file](https://github.com/yamcodes/akin/blob/poc/main.py) - all UI and game logic in one file. Uses [akinator.py](https://github.com/Ombucha/akinator.py).\n\n![PoC screenshot](./assets/poc.png)\n\n```mermaid\ngraph LR\n    poc[\"main.py\u003cbr/\u003e(UI + game logic)\"] --\u003e lib[\"akinator.py\"]\n```\n\n### Phase 1: TUI\n\n[`phase1`](https://github.com/yamcodes/akin/tree/phase1) - the PoC is split into two separate Python packages: `engine/` and `tui/`; TUI imports the engine directly and serves a cleaner CLI experience.\n\n![Phase 1 screenshot](./assets/phase1.png)\n\n```mermaid\ngraph LR\n    tui[\"tui/\"] --import--\u003e engine[\"engine/\"]\n```\n\n### Phase 2: HTTP ← current\n\n[`phase2`](https://github.com/yamcodes/akin/tree/phase2) - Engine and TUI are independent services (separate `uv` projects).\nThey communicate over HTTP. Engine ships as a Docker image.\n\n![Phase 2 screenshot](./assets/phase2.png)\n\n**Cloudflare note:** akinator.com is behind Cloudflare. The engine uses [`curl-cffi`](https://github.com/yifeikong/curl-cffi) to impersonate Chrome's TLS fingerprint, which passes bot detection reliably in any environment including Docker. Without this, the `akinator` library (using `cloudscraper`) only solves JS challenges but leaves Python's TLS fingerprint exposed, causing 403 errors in containers.\n\n```mermaid\ngraph LR\n    tui[\"tui/\"] --HTTP--\u003e engine[\"engine/ :8000\"]\n```\n\n### Phase 3: Homebrew\n\nTUI is packaged as a proper Python package and distributed via Homebrew.\nRequires converting `tui/` from a flat-module layout to a real package (`akin_tui/`)\nso that non-Python assets (e.g. `app.tcss`) are included in the wheel.\n\n### Phase 4: Hypermedia\n\nA `web/` server is added for browser clients.\nThe engine has no awareness of who is calling it.\n\n```mermaid\ngraph LR\n    tui[\"tui/\"] --HTTP--\u003e engine[\"engine/ :8000\"]\n    browser[\"browser\"] --HTTP--\u003e web[\"web/\"] --HTTP--\u003e engine\n```\n\n## Repository layout\n\n| Path                 | Description                                                   |\n| -------------------- | ------------------------------------------------------------- |\n| `engine/`            | Game logic + FastAPI HTTP server ([README](engine/README.md)) |\n| `tui/`               | Textual TUI client ([README](tui/README.md))                  |\n| `web/`               | Spring Boot hypermedia server (Phase 4, not yet implemented)  |\n| `docker-compose.yml` | Starts the engine service                                     |\n\n## Acknowledgements\n\n- [fiorix](https://gist.github.com/fiorix) for the [akinator.py gist](https://gist.github.com/fiorix/3152830) that inspired this project\n- [Ombucha](https://github.com/Ombucha) for the [akinator.py library](https://github.com/Ombucha/akinator.py) that powers the engine\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyamcodes%2Fakin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyamcodes%2Fakin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyamcodes%2Fakin/lists"}