{"id":19183996,"url":"https://github.com/alxjpzmn/chirp","last_synced_at":"2026-06-11T23:31:13.931Z","repository":{"id":216010446,"uuid":"717585678","full_name":"alxjpzmn/chirp","owner":"alxjpzmn","description":"Convert the text content of URLs into a podcast feed, read by OpenAI's TTS API","archived":false,"fork":false,"pushed_at":"2024-01-23T21:26:27.000Z","size":606,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-23T02:31:14.417Z","etag":null,"topics":["openai-api","podcast","rss","rss-generator","tts","tts-api"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/alxjpzmn.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}},"created_at":"2023-11-11T23:08:54.000Z","updated_at":"2024-01-23T00:03:53.000Z","dependencies_parsed_at":"2024-01-23T22:31:12.756Z","dependency_job_id":null,"html_url":"https://github.com/alxjpzmn/chirp","commit_stats":null,"previous_names":["alxjpzmn/chirp"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/alxjpzmn/chirp","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alxjpzmn%2Fchirp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alxjpzmn%2Fchirp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alxjpzmn%2Fchirp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alxjpzmn%2Fchirp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alxjpzmn","download_url":"https://codeload.github.com/alxjpzmn/chirp/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alxjpzmn%2Fchirp/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34222709,"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-11T02:00:06.485Z","response_time":57,"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":["openai-api","podcast","rss","rss-generator","tts","tts-api"],"created_at":"2024-11-09T11:05:49.066Z","updated_at":"2026-06-11T23:31:13.913Z","avatar_url":"https://github.com/alxjpzmn.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Chirp\n\nConvert the text content of URLs into a podcast feed, each article becoming an episode read by [OpenAI's TTS API](https://platform.openai.com/docs/guides/text-to-speech).\n\n🚧 Chirp is in early beta state – it works, but expect quite a few rough edges.\n\n\u003cimg alt=\"Screenshot of Chirp\" src=\"./.github/chirp-screenshot.png\" style=\"width: 100%\" /\u003e\n\n## Getting Started\n\nYou'll need an OpenAI API key: https://platform.openai.com/api-keys. I also recommend to set a monthly budget: https://platform.openai.com/account/limits.\n\n### Quick Start\n\nTo give Chirp a quick spin, use:\n\n```\ndocker run -d \\\n  --name chirp \\\n  -v /home/your-chirp-data:/data \\\n  -e OPENAI_API_KEY=your-openai-api-key \\\n  -p 3000:3000 \\\n  ghcr.io/alxjpzmn/chirp:latest\n```\n\n### Setup\n\nFor a more persistent setup of Chirp, it's best to have a Redis instance running separately, e.g. through their official [Docker image](https://hub.docker.com/_/redis/). If you do so, don't forget to set the two Redis-related environment variables (more on environment variables below).\n\nYou can configure the following environment variables (if you run Chirp via `bun run dev`, just create a `.env` file inside the `packages/core` directory and add them there):\n\n| Name              | Effect                                                                                                                                                                                   |\n| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| OPENAI_API_KEY    | Mandatory, authenticates you against OpenAI's TTS API                                                                                                                                    |\n| PASSWORD          | Optional, adds basic authentication using JWTs for your instance. Beware that your feed itself and its data are always public since podcast players don't play well with authentication. |\n| MAX_ARTICLE_CHARS | Optional, this is useful for development if you want to test things and don't want to rack up bills with OpenAI. I use 200 in development.                                               |\n| SSL               | Optional, in case you have Chirp served via HTTPS you will need to set this to true or the feed won't work. Defaults to false.                                                           |\n| PORT              | Optional, defaults to `3000`.                                                                                                                                                            |\n| DATA_DIR          | Optional, defaults to the directory Chirp is being executed from.                                                                                                                        |\n| REDIS_HOST        | Optional, defaults to `localhost`. If not specified, a Redis instance will be spun up inside the Chirp container.                                                                        |\n| REDIS_PORT        | Optional, defaults to `6379`.                                                                                                                                                            |\n\n### Notes\n\n- Beware that Overcast and Castro seem to expect a publicly available podcast feed. Apple Podcasts and direct RSS also work within a e.g. a VPN network.\n- Getting the TTS file (and merging it via FFmpeg ) takes some time. For longer texts, expect a couple of minutes. I'll be adding more verbose progress indicators.\n- If you set a server password, this will currently only put the `/api` REST endpoints behind a JWT validation. The podcast feed and its required files (e.g. the feed cover) plus the websocket endpoints won't be requiring a valid token.\n\n## Developer Guide\n\n- PRs are more than welcome! If you'd like to make improvements to the code, add a new feature, fix a bug etc., feel free to just work on a separate branch and open a PR, I'll review merge to `main` asap.\n- To contribute, you'll need the Bun runtime: https://bun.sh.\n- Chirp is organized as a monorepo, with a web client using React with Vite and the core (backend) using Bun. There's a shared package to share types and utility functions between the two.\n- In case you've never spun up Redis before, but pulled the Docker image already, you can run `bun run redis` inside the main directory.\n- To spin up both the Vite development server and the Bun backend, just run `bun run dev` inside the main directory.\n\n## Acknowledgements\n\nChirp depends on a lot of other projects. Here's an (incomplete) list of them:\n\n- [OpenAI TTS API](https://platform.openai.com/docs/guides/text-to-speech): I've tried other TTS APIs, but this one has the best quality so far in my view.\n- [Bun](https://bun.sh): hyped for a reason, it really is that fast, well documented and convenient to use\n- [Elysia](https://elysiajs.com): effortless APIs with Bun\n- [Chakra UI](https://chakra-ui.com): It's ridiculously simple to hack together a decent looking web app with it\n- [Phosphor Icons](https://phosphoricons.com): some of the most beautiful and versatile icons around\n- [Readability](https://github.com/mozilla/readability): extracts the text content of an URL, this is what Firefox uses for its reader view and the folks at the Mozilla foundation were kind enough to pack it into a Node lib, too\n- [FFmpeg](https://ffmpeg.org): https://www.youtube.com/watch?v=9kaIXkImCAM\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falxjpzmn%2Fchirp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falxjpzmn%2Fchirp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falxjpzmn%2Fchirp/lists"}