ceelog/openweread

OpenWeRead is a TypeScript toolkit for talking to WeChat Read, a popular Chinese e-reader app made by Tencent. WeChat Read recently published an official set of public endpoints called Skills, and this project wraps those endpoints in two ways: a software development kit, or SDK, that other TypeScript programs can pull in, and a command-line tool that you run in your terminal to get information out of your account. The README is written in Chinese. To use either tool you first need a personal API key, formatted like wrk-xxxxxxxx, which you obtain from the WeChat Read Skills website linked in the README. The key is then stored in an environment variable called WEREAD_API_KEY. Installation is one npm command for the global command-line tool, or pnpm add openweread inside an existing project to use the SDK. The command-line tool covers most of what a reader would want to inspect: searching for books, fetching a book's metadata or chapter list, checking reading progress, showing your bookshelf including audio books, monthly reading stats, your bookmarks and highlights for a given book, your personal notes and reviews, the popular highlights other users have made on a book, recommended and similar books, and your overall profile. Any command can be given a --json flag to print the raw JSON for piping to other tools. The SDK exposes the same features as JavaScript methods on a client object, and includes a lower-level call function for endpoints that the high-level wrappers do not cover yet. The project uses vitest for tests, biome for linting, and is released under the MIT license.