{"id":13539358,"url":"https://github.com/qmk/qmk_cli","last_synced_at":"2025-06-10T21:19:14.171Z","repository":{"id":34987626,"uuid":"194550935","full_name":"qmk/qmk_cli","owner":"qmk","description":"A program to help users work with QMK","archived":false,"fork":false,"pushed_at":"2025-05-28T13:14:51.000Z","size":296,"stargazers_count":160,"open_issues_count":11,"forks_count":41,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-06-02T11:19:10.281Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","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/qmk.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":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"open_collective":"qmk-firmware"}},"created_at":"2019-06-30T19:00:33.000Z","updated_at":"2025-05-28T18:44:12.000Z","dependencies_parsed_at":"2023-09-22T08:13:36.782Z","dependency_job_id":"dddc6b0d-ce8a-4ce6-8ae7-6a9fb6cb8c13","html_url":"https://github.com/qmk/qmk_cli","commit_stats":{"total_commits":296,"total_committers":13,"mean_commits":22.76923076923077,"dds":0.5067567567567568,"last_synced_commit":"ed0d5699ffafde8811109d8acdea1dc70b52ac83"},"previous_names":[],"tags_count":72,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qmk%2Fqmk_cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qmk%2Fqmk_cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qmk%2Fqmk_cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qmk%2Fqmk_cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/qmk","download_url":"https://codeload.github.com/qmk/qmk_cli/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qmk%2Fqmk_cli/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":258798952,"owners_count":22759752,"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-08-01T09:01:24.131Z","updated_at":"2025-06-10T21:19:14.134Z","avatar_url":"https://github.com/qmk.png","language":"Python","funding_links":["https://opencollective.com/qmk-firmware"],"categories":["Python","Keyboard"],"sub_categories":[],"readme":"# QMK CLI\n[![CLI Setup](https://github.com/qmk/qmk_cli/actions/workflows/cli_setup.yml/badge.svg)](https://github.com/qmk/qmk_cli/actions/workflows/cli_setup.yml)\n\nA program to help users work with [QMK Firmware](https://qmk.fm/).\n\n# Features\n\n* Interact with your qmk_firmware tree from any location\n* Use `qmk clone` to pull down anyone's `qmk_firmware` fork\n* Setup your build environment with `qmk setup`\n* Use `qmk console` to get debugging information from your keyboard(s)\n* Check that your environment is correctly setup with `qmk doctor`\n* Integrates with qmk_firmware for additional functionality:\n    * `qmk compile`\n    * `qmk info`\n    * `qmk flash`\n    * `qmk lint`\n    * ...and many more!\n\n# Packages\n\nWe provide \"install and go\" packages for many Operating Systems.\n\n## Linux\n\nPackages for several distributions available here: https://github.com/qmk/qmk_fpm\n\n## macOS\n\nUsing [Homebrew](https://brew.sh):\n\n    brew install qmk/qmk/qmk\n\n## Windows\n\nDownload our custom MSYS2 installer here: https://msys.qmk.fm/\n\n# Quickstart\n\n* `python3 -m pip install qmk`\n* `qmk setup`\n\n# Building\n\nWe follow PEP517, you can install using [build](https://pypi.org/project/build/):\n\nSetup:\n\n    python3 -m pip install build\n\nBuild:\n\n    python3 -m build\n\nYou can read more about working with PEP517 packages in the [Python Packaging User Guide](https://packaging.python.org/guides/distributing-packages-using-setuptools/#packaging-your-project).\n\n# Documentation\n\nFull documentation: \u003chttps://docs.qmk.fm/#/tutorial\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqmk%2Fqmk_cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqmk%2Fqmk_cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqmk%2Fqmk_cli/lists"}