{"id":13610305,"url":"https://github.com/LoLei/razer-cli","last_synced_at":"2025-04-12T22:33:28.484Z","repository":{"id":48634570,"uuid":"175453252","full_name":"LoLei/razer-cli","owner":"LoLei","description":"CLI for configuring Razer devices","archived":false,"fork":false,"pushed_at":"2024-04-04T06:49:52.000Z","size":6990,"stargazers_count":89,"open_issues_count":10,"forks_count":11,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-02T12:03:55.522Z","etag":null,"topics":["cli","colors","effects","hacktoberfest","linux","pywal","razer","rice","x"],"latest_commit_sha":null,"homepage":"","language":"Python","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/LoLei.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":"2019-03-13T15:54:45.000Z","updated_at":"2024-09-30T04:29:19.000Z","dependencies_parsed_at":"2024-04-04T07:40:06.451Z","dependency_job_id":"d6dae27f-30dd-4c3c-a4a9-3ed6b0792f7c","html_url":"https://github.com/LoLei/razer-cli","commit_stats":{"total_commits":178,"total_committers":9,"mean_commits":19.77777777777778,"dds":0.2640449438202247,"last_synced_commit":"e4c9a93f012fea2362e18c3374a38bc77a62d86b"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LoLei%2Frazer-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LoLei%2Frazer-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LoLei%2Frazer-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LoLei%2Frazer-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LoLei","download_url":"https://codeload.github.com/LoLei/razer-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223549179,"owners_count":17163607,"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":["cli","colors","effects","hacktoberfest","linux","pywal","razer","rice","x"],"created_at":"2024-08-01T19:01:43.436Z","updated_at":"2024-11-07T16:31:00.492Z","avatar_url":"https://github.com/LoLei.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# razer-cli\n\u003c!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --\u003e\n[![All Contributors](https://img.shields.io/badge/all_contributors-6-orange.svg?style=flat-square)](#contributors-)\n\u003c!-- ALL-CONTRIBUTORS-BADGE:END --\u003e\nCommand line interface for controlling Razer devices on Linux\n\n## About\nWith this command line interface you can configure your Razer peripherals, such\nas keyboard and mouse, set their colors and effects, etc.\n\nThe most simple use case (for which this tool was originally developed) is to\nuse it in symbiosis with [`pywal`](https://github.com/dylanaraps/pywal). Then\nthis tool will set your Razer colors to Pywal's colors. See below for more\ninformation.\n\n## Installation\n[`pip install razer-cli`](https://pypi.org/project/razer-cli/)\n\nOR\n\n```\ngit clone https://github.com/LoLei/razer-cli.git\ncd razer-cli\nsudo python setup.py install\n```\nOR\n\n```\ngit clone https://github.com/LoLei/razer-cli.git\ncd razer-cli\npip install . --user\n```\n\n## Usage\n```\n$ razer-cli -h\nusage: razer-cli [-h] [-man [MANUAL ...]] [-v] [-d DEVICE [DEVICE ...]]\n                 [-a] [-e EFFECT [EFFECT ...]] [-c COLOR [COLOR ...]]\n                 [-z ZONES [ZONES ...]] [-b BRIGHTNESS [BRIGHTNESS ...]]\n                 [--dpi DPI] [--poll POLL]\n                 [--battery BATTERY [BATTERY ...]] [-l] [-ll] [-ls]\n                 [--sync] [--restore] [--version]\n\noptional arguments:\n  -h, --help            show this help message and exit\n  -man [MANUAL ...], --manual [MANUAL ...]\n                        Print help details for given feature(s)\n  -v, --verbose         increase output verbosity\n  -d DEVICE [DEVICE ...], --device DEVICE [DEVICE ...]\n                        only affect these devices, same name as output of\n                        -l\n  -a, --automatic       try to find colors and set them to all devices\n                        without user arguments, uses X or pywal colors\n  -e EFFECT [EFFECT ...], --effect EFFECT [EFFECT ...]\n                        set effect\n  -c COLOR [COLOR ...], --color COLOR [COLOR ...]\n                        choose color (default: X color1), use one argument\n                        for hex, or three for base10 rgb\n  -z ZONES [ZONES ...], --zone ZONES [ZONES ...]\n                        choose zone for color(s)\n  -b BRIGHTNESS [BRIGHTNESS ...], --brightness BRIGHTNESS [BRIGHTNESS ...]\n                        set brightness of device\n  --dpi DPI             set DPI of device (use print as a value to show\n                        it)\n  --poll POLL           set polling rate of device (use print as a value\n                        to show it)\n  --battery BATTERY [BATTERY ...]\n                        set low threshold and/or idle delay (use print as\n                        a value to show it)\n  -l, --list_devices    list available devices, settings, and their\n                        supported capabilities/effects\n  -ll, --list_devices_long\n                        list available devices settings, and list their\n                        supported capabilities/effects\n  -ls, --list_devices_short\n                        list available devices and their settings\n  --sync                sync lighting effects to all supported Razer\n                        products\n  --restore             Load last used settings\n  --version             Print version number\n```\n\u003csup\u003eThis might be out of date, just run it with `-h` yourself to see the newest\noptions.\u003c/sup\u003e  \n\n### Example usage with Pywal\nTo get your mouse and keyboard to use Pywal's colors, simply start `razer-cli`\nwith the `-a` flag, after having executed `wal`: `razer-cli -a`  \nExample in action \n[here](https://github.com/LoLei/dotfiles/blob/master/exec-wal.sh).\n\nAnother option is to use `razer-cli -e multicolor,xpalette`, which not only \nuses a single color from pywal, but uses the entire 16 color palette.\n\n#### Other examples\n`$ razer-cli -e ripple -c ff0000`  \n`$ razer-cli -e static -c ffffff`  \n\nYou can also leave out the color or the effect:  \n`$ razer-cli -e breath_single`  \n`$ razer-cli -c 55ff99`\n\nCurrently this will imply the `-a` flag being used for the missing setting. I\nplan on also having the option to reuse the current color/effect, if the\nargument is missing, in the future.\n\n#### Effects\nEffects are listed in\n[`razer_cli/settings.py`](https://github.com/LoLei/razer-cli/blob/master/razer_cli/settings.py).\nThe effects that are supported per device can be listed with `razer-cli -l[l]`.\nSome of the built-in effects or not implemented yet. If such an effect is\nchosen, a notice will be logged. There are also custom effects that do not exist\nnormally, such as `multicolor`, which is described in the same file.\n\nHere's a showcase of that effect:\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/LoLei/razer-cli/master/images/randomshowcase.gif\"\u003e\n\u003c/p\u003e\n\n#### Other symbiosis tools\n* [`wpgtk`](https://github.com/deviantfero/wpgtk)\n* [`Chameleon`](https://github.com/GideonWolfe/Chameleon)\n\n## Dependencies\n* [`openrazer`](https://github.com/openrazer/openrazer)\n  * :warning: Do not install `openrazer` from [pip](https://pypi.org/project/openrazer/), which is something else.\n  * Instead install it from one of the various package managers of your distribution.\n* [`xrdb`](https://www.archlinux.org/packages/extra/x86_64/xorg-xrdb/)\n  * Also available on most distros.\n\n## Disclaimer\nNot all devices have been tested, but basic effects should work everywhere. Some guesswork is being done as to what capabilities are supported on specific devices. If you need more advanced configuration, consider using the GUIs [Polychromatic](https://github.com/polychromatic/polychromatic/), [RazerGenie](https://github.com/z3ntu/RazerGenie) or [RazerCommander](https://gitlab.com/gabmus/razerCommander) which have specific implementations for most devices.\n  \nFeel free to open feature request issues or PRs.\n\n## Contributors ✨\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctbody\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/Ansis100\"\u003e\u003cimg src=\"https://avatars2.githubusercontent.com/u/35926716?v=4?s=100\" width=\"100px;\" alt=\"Ansis\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eAnsis\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/LoLei/razer-cli/commits?author=Ansis100\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://t1c.dev\"\u003e\u003cimg src=\"https://avatars0.githubusercontent.com/u/44733677?v=4?s=100\" width=\"100px;\" alt=\"Kainoa Kanter\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eKainoa Kanter\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"#ideas-ThatOneCalculator\" title=\"Ideas, Planning, \u0026 Feedback\"\u003e🤔\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://www.ifohancroft.com\"\u003e\u003cimg src=\"https://avatars0.githubusercontent.com/u/3461282?v=4?s=100\" width=\"100px;\" alt=\"IFo Hancroft\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eIFo Hancroft\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/LoLei/razer-cli/issues?q=author%3Aifohancroft\" title=\"Bug reports\"\u003e🐛\u003c/a\u003e \u003ca href=\"#userTesting-ifohancroft\" title=\"User Testing\"\u003e📓\u003c/a\u003e \u003ca href=\"https://github.com/LoLei/razer-cli/commits?author=ifohancroft\" title=\"Documentation\"\u003e📖\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/GM-Script-Writer-62850\"\u003e\u003cimg src=\"https://avatars2.githubusercontent.com/u/564653?v=4?s=100\" width=\"100px;\" alt=\"GM-Script-Writer-62850\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eGM-Script-Writer-62850\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/LoLei/razer-cli/commits?author=GM-Script-Writer-62850\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/sk8ersteve\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/10476999?v=4?s=100\" width=\"100px;\" alt=\"Stephen Thomas-Dorin\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eStephen Thomas-Dorin\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/LoLei/razer-cli/commits?author=sk8ersteve\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/romainrichard\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/498307?v=4?s=100\" width=\"100px;\" alt=\"Romain Richard\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eRomain Richard\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/LoLei/razer-cli/commits?author=romainrichard\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n  \u003c/tbody\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FLoLei%2Frazer-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FLoLei%2Frazer-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FLoLei%2Frazer-cli/lists"}