{"id":19054382,"url":"https://github.com/datadog/documentor","last_synced_at":"2025-04-24T03:14:53.391Z","repository":{"id":250351063,"uuid":"800525787","full_name":"DataDog/documentor","owner":"DataDog","description":"Improve technical documentation with the power of AI.","archived":false,"fork":false,"pushed_at":"2025-03-05T18:18:41.000Z","size":208,"stargazers_count":30,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"trunk","last_synced_at":"2025-04-24T03:14:46.495Z","etag":null,"topics":["ai","anthropic","claude","command-line","command-line-tool","documentation","documentation-tool","gpt","llm","openai"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DataDog.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE-3rdparty.csv","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-05-14T13:56:23.000Z","updated_at":"2025-03-08T12:12:50.000Z","dependencies_parsed_at":"2024-12-30T18:22:01.985Z","dependency_job_id":"31d2f2cd-b39f-411c-9bad-2e53d6405546","html_url":"https://github.com/DataDog/documentor","commit_stats":null,"previous_names":["datadog/documentor"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DataDog%2Fdocumentor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DataDog%2Fdocumentor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DataDog%2Fdocumentor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DataDog%2Fdocumentor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DataDog","download_url":"https://codeload.github.com/DataDog/documentor/tar.gz/refs/heads/trunk","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250552079,"owners_count":21449165,"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","anthropic","claude","command-line","command-line-tool","documentation","documentation-tool","gpt","llm","openai"],"created_at":"2024-11-08T23:38:12.303Z","updated_at":"2025-04-24T03:14:53.370Z","avatar_url":"https://github.com/DataDog.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# `documentor`\n\n`documentor` is an easy-to-use, efficient, and powerful command-line\napplication that uses the power of AI to review documentation and\nprovide feedback on how to improve it, draft new documentation from\nscratch, and more.\n\nIt assists documentation writers in creating better documentation by\nautomating parts of the writing and review process, allowing them to\nfocus on the content and structure of the document itself.\n\n## Installation\n\n### From source\n\nFirst, ensure that the following dependencies are installed:\n\n- Go 1.24 or above.\n- make.\n- [scdoc](https://git.sr.ht/~sircmpwn/scdoc).\n\nOptionally, you can install\n[glow](https://github.com/charmbracelet/glow) to render the Markdown\noutput of the `review` command with more style.\n\nThen, switch to the latest stable tag (`v1.2.0`), compile, and install:\n\n```bash\ngit checkout v1.2.0\nmake\nsudo make install\n```\n\n## Usage\n\n\u003e [!NOTE] \n\u003e If you're a Datadog employee, please follow [the documentation in\n\u003e Confluence](https://datadoghq.atlassian.net/wiki/spaces/Cloudcraft/pages/4780427137/Using+Documentor).\n\n```bash\n$ documentor --help\nNAME:\n   documentor - improve technical documentation with the power of AI\n\nUSAGE:\n   documentor [global options] command [command options]\n\nVERSION:\n   1.2.0\n\nCOMMANDS:\n   review, r    review technical documentation\n   describe, d  describe an image and generate alt text\n   draft, D     draft new documentation based on the provided notes\n\nGLOBAL OPTIONS:\n   --key value, -k value          the API key to use [$DOCUMENTOR_KEY]\n   --provider value, -p value     the AI provider to use (default: \"openai\") [$DOCUMENTOR_PROVIDER]\n   --endpoint value, -e value     the API endpoint to use (currently only used for the Datadog provider) [$DOCUMENTOR_ENDPOINT]\n   --model value, -m value        the AI model to use (default: \"gpt-4o\") [$DOCUMENTOR_MODEL]\n   --temperature value, -t value  the temperature to use for the model (default: 0.8) [$DOCUMENTOR_TEMPERATURE]\n   --help, -h                     show help\n   --version, -v                  print the version\n```\n\n### Examples\n\n**1. Review a documentation file using the default provider, OpenAI:**\n\n```bash\ndocumentor --key 'your-openai-api-key' review '/path/to/file.md'\n```\n\n**2. Review a documentation file with the API key set in the environment:**\n\n```bash\nexport DOCUMENTOR_KEY='your-openai-api-key'\ndocumentor review '/path/to/file.md'\n```\n\n**3. Save the output to a file:**\n\n```bash\ndocumentor review '/path/to/file.md' \u003e\u003e review.md\n```\n\n**4. Format the default Markdown output with glow:**\n\n```bash\ndocumentor review '/path/to/file.md' | glow\n```\n\n**5. Describe an image:**\n\n```bash\ndocumentor describe '/path/to/image.png'\n```\n\n**6. Describe an image with context:**\n\n```bash\ndocumentor describe --context 'This my cat, Mittens.' '/path/to/image.png'\n```\n\n**7. Describe an image and generate a filename for the image:**\n\n```bash\ndocumentor describe --filename '/path/to/image.png'\n```\n\n**8. Draft a document based on your notes:**\n\n```bash\ndocumentor draft '/path/to/notes/file.md'\n```\n\n**9. Draft a document using Anthropic as the AI provider:**\n\n```bash\ndocumentor --provider 'anthropic' --key 'your-anthropic-api-key' draft '/path/to/notes/file.md'\n```\n\n**10. Review a document using a different LLM model:**\n\n```bash\ndocumentor --model 'o3-mini' review '/path/to/file.md'\n```\n\nRefer to the _documentor(1)_ manpage after installation for more\ninformation.\n\n## Contributing\n\nAnyone can help make `documentor` better. Refer to the [contribution\nguidelines](CONTRIBUTING.md) for more information.\n\n---\n\nThis project is released under the [Apache-2.0 License](LICENSE.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdatadog%2Fdocumentor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdatadog%2Fdocumentor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdatadog%2Fdocumentor/lists"}