{"id":15007713,"url":"https://github.com/peterdanwan/gimme_readme","last_synced_at":"2025-10-30T11:32:00.114Z","repository":{"id":255917511,"uuid":"853141595","full_name":"peterdanwan/gimme_readme","owner":"peterdanwan","description":"gimme_readme is a command-line tool powered by AI that generates a comprehensive README.md file for your project. It analyzes multiple source code files at once, providing concise explanations of each file's purpose, functionality, and key components, all in a single, easy-to-read document.","archived":false,"fork":false,"pushed_at":"2024-11-22T23:25:19.000Z","size":1178,"stargazers_count":22,"open_issues_count":0,"forks_count":4,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-02T08:12:08.798Z","etag":null,"topics":["ai","developer-tool","hacktoberfest","npm-package","open-source","readme"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/gimme_readme","language":"JavaScript","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/peterdanwan.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":"2024-09-06T04:25:41.000Z","updated_at":"2024-11-26T14:42:10.000Z","dependencies_parsed_at":"2024-09-28T15:20:55.589Z","dependency_job_id":"908f41d6-c870-4592-9c0c-ef72ea9b3b45","html_url":"https://github.com/peterdanwan/gimme_readme","commit_stats":null,"previous_names":["peterdanwan/gimme_readme"],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peterdanwan%2Fgimme_readme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peterdanwan%2Fgimme_readme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peterdanwan%2Fgimme_readme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peterdanwan%2Fgimme_readme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/peterdanwan","download_url":"https://codeload.github.com/peterdanwan/gimme_readme/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238960783,"owners_count":19559340,"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":["ai","developer-tool","hacktoberfest","npm-package","open-source","readme"],"created_at":"2024-09-24T19:13:30.904Z","updated_at":"2025-10-30T11:32:00.108Z","avatar_url":"https://github.com/peterdanwan.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gimme_readme\n\n`gimme_readme` is a command-line tool powered by AI that generates a comprehensive `README.md` file for your project. It analyzes multiple source code files at once, providing concise explanations of each file's purpose, functionality, and key components, all in a single, easy-to-read document.\n\n![gimme_readme-0.1-demo-revised](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/tqp31p7fm8m15ss3qkwl.gif)\n\nSee our [0.1 Release Demo](https://youtu.be/S6v-u9o_Xx8)!\n\n## Table of Contents\n\n1. [Getting Started](#1-getting-started)\n2. [Usage](#2-usage)\n3. [Example Usage](#3-example-usage)\n4. [Supported Models by Providers](#4-supported-models-by-providers)\n5. [Contributing](#5-contributing)\n6. [Code of Conduct](#6-code-of-conduct)\n7. [License](#7-license)\n8. [Author](#8-author)\n\n## 1. Getting Started\n\nTo get started with `gimme_readme`, follow these steps:\n\n1. Install the latest _long term support_ version of [Node.js](https://nodejs.org/en/download/package-manager) for your operating system.\n2. Run the following command to install `gimme_readme` globally:\n\n   ```sh\n   npm i -g gimme_readme\n   ```\n\n   NOTE: MAC/LINUX users may need to run `sudo npm i -g gimme_readme`\n\n3. Generate a configuration file by running in _any_ folder you'd like:\n\n   ```sh\n   gr-ai -c\n   ```\n\n   This command creates a `.gimme_readme_config` file in your home directory. **Do not move this file from this location.**\n\n4. Open the `.gimme_readme_config` file and add your API keys and preferred default values as prompted. Ensure you leave the variable names unchanged.\n\n   - Subsequent runs of `gr-ai -c` will display the path to your existing config file.\n   - See [here](./env.sample) for an example of what a `.gimme_readme_config` file looks like!\n\n## 2. Usage\n\n`gimme_readme` uses AI to generate a `README.md` file that explains a given source code file or files. Below are the available options:\n\n| Option                         | Description                                                                       |\n| ------------------------------ | --------------------------------------------------------------------------------- |\n| `-v`, `--version`              | Output the current version                                                        |\n| `-f`, `--file [files...]`      | Specify one or more files to generate explanations for                            |\n| `-o`, `--outputFile \u003cstring\u003e`  | Specify the file to output the generated README to                                |\n| `-m`, `--model \u003cstring\u003e`       | Choose a free-tier AI model to use (e.g., gemini, openai, grok)                   |\n| `-p`, `--prompt \u003cstring\u003e`      | Provide a custom prompt to the AI                                                 |\n| `-pf`, `--promptFile \u003cstring\u003e` | Specify a prompt file                                                             |\n| `-c`, `--config`               | Show the location of the configuration file and provide links to examples         |\n| `-t`, `--temperature \u003cnumber\u003e` | Set the level of determinism for the AI (value between 0 and 1)                   |\n| `-tkn`, `--token`              | Get information on the tokens consumed (i.e., prompt, completion, \u0026 total tokens) |\n| `-h`, `--help`                 | Display help for the command                                                      |\n\n## 3. Example Usage\n\nBelow are some simple examples to help you get started with `gimme_readme`. For more detailed examples,\nsee [here](./_examples/README.md).\n\n### Display Help\n\nTo display the help menu with all available commands:\n\n```sh\ngr-ai -h\n```\n\n### Display Version Number\n\nTo show the current version of `gimme_readme`:\n\n```sh\ngr-ai -v\n```\n\n### Generate a README for a Source File\n\nTo generate a `README.md` file for one or more source files:\n\n```sh\ngr-ai -f example.js anotherFile.py -o README.md -m gemini-2.0-flash\n```\n\n### Generate the number of tokens used during the API call\n\n```sh\ngr-ai -f example.js anotherFile.py -o README.md -m gemini-2.0-flash -tkn\ngr-ai -f example.js anotherFile.py -o README.md -m llama3-8b-8192 --token\n```\n\n## 4. Supported Models by Providers\n\n| Provider | Models                             |\n| -------- | ---------------------------------- |\n| `gemini` | gemini-2.0-flash, gemini-1.5-flash |\n| `groq`   | llama3-8b-8192                     |\n\n## 5. Contributing\n\nWe welcome contributions to improve `gimme_readme`! To get started with contributing, we ask that you read our [contributing guide](./CONTRIBUTING.md)\n\n## 6. Code of Conduct\n\nWe are committed to providing a welcoming and inclusive experience for everyone. By participating in this project, you agree to abide by our [Code of Conduct](./CODE_OF_CONDUCT.md).\n\n## 7. License\n\nThis project is licensed under the MIT license. You are free to use, modify, and distribute this code, subject to the terms in the [LICENSE](./LICENSE) file.\n\n## 8. Author\n\nDeveloped by [Peter Wan](https://github.com/peterdanwan).\n\nFor any questions or feedback, feel free to reach out through the GitHub repository.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeterdanwan%2Fgimme_readme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpeterdanwan%2Fgimme_readme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpeterdanwan%2Fgimme_readme/lists"}