{"id":18581889,"url":"https://github.com/coder/coder-doctor","last_synced_at":"2025-12-14T20:04:57.308Z","repository":{"id":39750839,"uuid":"393733390","full_name":"coder/coder-doctor","owner":"coder","description":"A preflight check tool for Coder","archived":true,"fork":false,"pushed_at":"2023-03-14T12:00:29.000Z","size":293,"stargazers_count":7,"open_issues_count":13,"forks_count":3,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-04-05T02:47:04.622Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://coder.com","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/coder.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":"2021-08-07T16:21:33.000Z","updated_at":"2025-02-16T02:59:32.000Z","dependencies_parsed_at":"2024-06-19T13:34:30.454Z","dependency_job_id":"cd740490-9cde-45e1-908b-1f155f1b1184","html_url":"https://github.com/coder/coder-doctor","commit_stats":{"total_commits":41,"total_committers":8,"mean_commits":5.125,"dds":0.5609756097560976,"last_synced_commit":"6491ee7afc134a7d592473c94d3ce8b7afa2f0c9"},"previous_names":["cdr/coder-doctor"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coder%2Fcoder-doctor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coder%2Fcoder-doctor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coder%2Fcoder-doctor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coder%2Fcoder-doctor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/coder","download_url":"https://codeload.github.com/coder/coder-doctor/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248208688,"owners_count":21065205,"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":[],"created_at":"2024-11-07T00:08:04.942Z","updated_at":"2025-12-14T20:04:51.959Z","avatar_url":"https://github.com/coder.png","language":"Go","readme":"# Coder Doctor 🧑‍⚕️\n\n[![GitHub Release](https://img.shields.io/github/v/release/coder/coder-doctor?color=6b9ded\u0026include_prerelease=false)](https://github.com/coder/coder-doctor/releases)\n[![Documentation](https://godoc.org/cdr.dev/coder-doctor?status.svg)](https://pkg.go.dev/cdr.dev/coder-doctor)\n[![Go Report Card](https://goreportcard.com/badge/cdr.dev/coder-doctor)](https://goreportcard.com/report/cdr.dev/coder-doctor)\n[![build](https://github.com/coder/coder-doctor/actions/workflows/build.yaml/badge.svg?event=push\u0026branch=main)](https://github.com/coder/coder-doctor/actions/workflows/build.yaml?query=branch%3Amain)\n[![Coverage Status](https://coveralls.io/repos/github/coder/coder-doctor/badge.svg?branch=main\u0026t=sEVzim)](https://coveralls.io/github/coder/coder-doctor?branch=main)\n\nCoder Doctor is a command-line diagnostic tool for checking that a\ngiven platform can run the Coder control plane and workspaces.\n\n## Supported Platforms\n\nCurrently, the following platforms are supported, with the following\npreflight checks:\n\n### Kubernetes\n\n- Kubernetes Version: checks that the selected Coder version is\n  compatible with the Kubernetes control plane.\n- Helm Version: checks the locally-installed Helm version for\n  compatibility with the requested version of Coder.\n- Kubernetes RBAC: checks that the service account has the required\n  permissions to run Coder.\n- Kubernetes Resources: checks that the cluster has the required\n  resource types available to run Coder.\n\n## Installation\n\nYou can manually download the latest [release](https://github.com/coder/coder-doctor/releases):\n\n1. Click a release and download the tar file for your operating system\n   (ex: coder-doctor-linux-amd64.tar.gz)\n1. (Optional, recommended) Download the `checksums.txt` for the desired\n   release and verify the `sha256` checksum of the file you downloaded.\n1. Extract the `coder-doctor` binary.\n1. Move the `coder-doctor` binary to somewhere in your `$PATH` (e.g., `mv coder-doctor /usr/local/bin/coder-doctor` for macOS/Linux).\n2. (macOS Users) You may need to [grant `coder-doctor` additional permissions](https://support.apple.com/en-us/HT202491) before running.\n\nAlternatively, use the below command, replacing `$VERSION`, `$OSTYPE`\n(one of `darwin`, `linux`, `windows`) and `$ARCH` (one of `amd64`, `arm64`)\nas required:\n\n```shell-session\n$ curl -fSsL \"https://github.com/coder/coder-doctor/releases/download/v${VERSION}/coder-doctor_${VERSION}_${OSTYPE}_${ARCH}.tar.gz\" | tar -xzvf -\nREADME.md\ncoder-doctor\n```\n\n## Usage\n\nTo check if your Kubernetes cluster is ready to install Coder, run:\n\n```console\ncoder-doctor check kubernetes\n```\n\nFor more information, you can run:\n\n```console\ncoder-doctor -h\n```\n\n## Development\n\nTo run from source, clone the repository and run:\n\n```bash\ngo run . help\n```\n\nThe `Makefile` also includes various helpful targets to run\nlinters and tests, but standard Go tools (e.g. `go test`)\nshould work as well.\n\n## Feedback\n\nWe love feedback! Please [open an issue] or [submit a pull request]\nwith any ideas for improving this.\n\n[open an issue]: https://github.com/coder/coder-doctor/issues\n[submit a pull request]: https://github.com/coder/coder-doctor/pulls\n\n**Note:** This tool is in `beta` state and Coder offers no compatibility\nguarantees, either for the tool itself or any public Go APIs. Most code\nis kept in the `internal` package to make this clear, and will be promoted\nto an externally-importable package once things stabilize.\n\n## Copyright and License\n\ncoder-doctor preflight diagnostic tool\n\nCopyright (C) 2021 Coder Technologies, Inc. \u0026lt;https://coder.com\u0026gt;\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with this program.  If not, see \u003chttps://www.gnu.org/licenses/\u003e.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoder%2Fcoder-doctor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcoder%2Fcoder-doctor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoder%2Fcoder-doctor/lists"}