{"id":20959647,"url":"https://github.com/danburonline/tlmr-cli","last_synced_at":"2026-04-27T09:01:50.871Z","repository":{"id":119128576,"uuid":"591017287","full_name":"danburonline/tlmr-cli","owner":"danburonline","description":"A CLI tool that uses GPT-4 to automatically generate summaries of scientific papers, formatted in the IMRaD structure, by simply adding PDFs of the papers to a user-specified directory.","archived":false,"fork":false,"pushed_at":"2023-07-19T15:18:25.000Z","size":33220,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-04-22T14:00:03.303Z","etag":null,"topics":["openai","paper","tldr"],"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/danburonline.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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":"2023-01-19T18:36:17.000Z","updated_at":"2023-09-08T18:40:34.000Z","dependencies_parsed_at":null,"dependency_job_id":"1a513d8c-fa5e-469b-8733-ef26d6e785ff","html_url":"https://github.com/danburonline/tlmr-cli","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/danburonline/tlmr-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danburonline%2Ftlmr-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danburonline%2Ftlmr-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danburonline%2Ftlmr-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danburonline%2Ftlmr-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/danburonline","download_url":"https://codeload.github.com/danburonline/tlmr-cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danburonline%2Ftlmr-cli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32329466,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-26T23:26:28.701Z","status":"online","status_checked_at":"2026-04-27T02:00:06.769Z","response_time":128,"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","paper","tldr"],"created_at":"2024-11-19T01:55:44.781Z","updated_at":"2026-04-27T09:01:50.865Z","avatar_url":"https://github.com/danburonline.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Too Long, Might Read\n\nToo Long, Might Read (TLMR) is a CLI tool that uses GPT4 to generate summaries of scientific papers. It targets papers formatted in the [IMRaD](https://en.wikipedia.org/wiki/IMRAD) structure. Just point TLMR to a directory containing your PDFs, and it will do the rest!\n\n## Installation\n\n### Prerequisites\n\n- OpenAI API key\n- Bun `\u003e= 0.6.14`\n\n### Steps\n\n1. Clone this repository.\n2. Install dependencies with `bun install`.\n3. Create a `.env` file in the root directory of the project and add your OpenAI API key:\n\n```txt\nOPENAI_API_KEY=\u003cyour OpenAI API key\u003e\n```\n\nAlternatively, when running the tool, you can pass your API key via the `-k` flag.\n\n## Build\n\nTo build the project, use Bun to compile the TypeScript:\n\n```bash\nbun build ./src/main.ts --compile --outfile tlmr\n```\n\nThis will create an executable called `tlmr` in the project's root directory.\n\n## Usage\n\nAfter building, you can run the tool with the following command:\n\n```bash\n./tlmr -f \u003cpath to folder with PDFs or single PDF\u003e\n```\n\nIf you opted not to use the .env file, pass the API key via the `-k` flag:\n\n```bash\n./tlmr -f \u003cpath to folder with PDFs or single PDF\u003e -k \u003cyour OpenAI API key\u003e\n```\n\n## Development\n\nDuring development, you can use Bun to run the script directly:\n\n```bash\nbun run start -f \u003cpath to folder with PDFs or single PDF\u003e\n```\n\nOr with the API key:\n\n```bash\nbun run start -f \u003cpath to folder with PDFs or single PDF\u003e -k \u003cyour OpenAI API key\u003e\n```\n\n## More About TLMR\n\nTLMR uses [LangChain.js](https://js.langchain.com) to communicate with the OpenAI API. The main logic is in [`src/main.ts`](./src/main.ts).\n\nThis project uses [Bun](https://bun.sh) instead of Node. By using Bun, we can write in TypeScript without needing a separate transpiler like Babel. Plus, it's a great opportunity to explore the capabilities of Bun, a promising tool for JavaScript/TypeScript development.\n\nTo get started, check out the example PDF in the example folder. There is also an [`.env.template`](.env.template) file in the project's root directory. Use this template to create your own `.env` file.\n\nHappy summarising!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanburonline%2Ftlmr-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdanburonline%2Ftlmr-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanburonline%2Ftlmr-cli/lists"}