{"id":19768288,"url":"https://github.com/matiasvlevi/gptdoc","last_synced_at":"2025-04-30T16:34:11.228Z","repository":{"id":129686166,"uuid":"609658111","full_name":"matiasvlevi/gptdoc","owner":"matiasvlevi","description":"Generate documentation comments with OpenAI models.","archived":false,"fork":false,"pushed_at":"2023-04-15T20:48:21.000Z","size":167,"stargazers_count":20,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-23T04:03:32.106Z","etag":null,"topics":["documentation","documentation-generator","documentation-tool","gpt-3","gpt-35-turbo","gpt-4","jsdoc","openai","tsdoc","typedoc"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/gptdoc","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/matiasvlevi.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-03-04T20:56:48.000Z","updated_at":"2025-01-10T07:37:03.000Z","dependencies_parsed_at":"2023-05-23T08:30:17.477Z","dependency_job_id":null,"html_url":"https://github.com/matiasvlevi/gptdoc","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matiasvlevi%2Fgptdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matiasvlevi%2Fgptdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matiasvlevi%2Fgptdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matiasvlevi%2Fgptdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/matiasvlevi","download_url":"https://codeload.github.com/matiasvlevi/gptdoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251742826,"owners_count":21636517,"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":["documentation","documentation-generator","documentation-tool","gpt-3","gpt-35-turbo","gpt-4","jsdoc","openai","tsdoc","typedoc"],"created_at":"2024-11-12T04:36:55.696Z","updated_at":"2025-04-30T16:34:10.483Z","avatar_url":"https://github.com/matiasvlevi.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003cimg width=\"200\" src=\"./docs/gptdoc.png\" alt=\"GPTDoc logo\"\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003eGenerate documentation comments with OpenAI models\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/matiasvlevi/gptdoc/#install-in-project\"\u003eInstall\u003c/a\u003e •\n  \u003ca href=\"https://github.com/matiasvlevi/gptdoc/blob/master/CONFIG.md\"\u003eDocumentation\u003c/a\u003e •\n  \u003ca href=\"https://github.com/matiasvlevi/gptdoc/blob/master/LICENSE\"\u003eLicense\u003c/a\u003e\n\u003c/p\u003e\n\n## Preview\n\nFunctions labeled with `/** @gpt */` get an autogenerated doc comment\n\n\u003ctable align=\"center\"\u003e\n\u003ctr\u003e\n\u003ctd align=\"center\"\u003e Before \u003c/td\u003e \u003ctd align=\"center\"\u003e After \u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\n\n```ts\n/** @gpt */\nfunction Greet(name) {\n    console.log(`Hello ${name}`);\n}\n```\n\n\u003c/td\u003e\n\u003ctd\u003e\n\n```ts\n/**\n * @autogenerated\n * @summary Generates a greeting to the passed in name\n * @param {string} name - The name to greet\n */\nfunction Greet(name) {\n    console.log(`Hello ${name}`);\n}\n```\n\n\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/table\u003e\n\u003cbr/\u003e\n\n## Install in project\n\nInstall `gptdoc` as a dev dependency\n\n```sh\nnpm i --save-dev gptdoc \n```\n\nExecute\n\n```sh\nnode node_modules/gptdoc [args]\n```\n\n## Config\n\nYou can specify a configuration file:\n\n```sh\nnode node_modules/gptdoc -c .myconfig\n```\n\nIf none provided, the script will look for `.gptdoc`\n\n### Sample Config file\n\n```json\n{\n    \"DEBUG\": false,\n    \"framework\": \"JSDOC\",\n    \"language\": \"JS\",\n    \"files\": {\n        \"src\": \"./src\",\n        \"dest\": \"./gpt\"\n    },\n    \"openai\": {\n        \"temperature\": 0.7,\n        \"top_p\": 1,\n        \"max_tokens\": 256,\n        \"model\": \"text-davinci-003\"\n    }\n}\n```\n\nFind more info about the config [here](./CONFIG.md)\n\n## API Key\n\nAdd a `.env` file in your root directory with `OPENAI_API_KEY`\n\nor set the `OPENAI_API_KEY` as a system environement variable.\n\nfind your API key [here](https://platform.openai.com/account/api-keys)\n\n### Document this project\n\nRunning `docself` in the cloned repo will document source files in `./src/`\n\n```sh\nnpm run docself\n```\n\nRunning `test` in the cloned repo will document `./example/example.js`\n\n```sh\nnpm run test\n```\n\n## Contributing\n\nConstructive criticism, Issues and PRs are more than welcome!\n\n---\n\nLicense MIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatiasvlevi%2Fgptdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmatiasvlevi%2Fgptdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatiasvlevi%2Fgptdoc/lists"}