{"id":13288858,"url":"https://github.com/pouyanh/carrot","last_synced_at":"2026-01-17T13:05:55.807Z","repository":{"id":150585014,"uuid":"162278970","full_name":"pouyanh/carrot","owner":"pouyanh","description":"Carrot awesomeWM personalization application","archived":false,"fork":false,"pushed_at":"2019-07-29T07:16:45.000Z","size":71,"stargazers_count":18,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-07-29T17:03:39.442Z","etag":null,"topics":["awesomewm","lua"],"latest_commit_sha":null,"homepage":"https://pouyanh.github.io/carrot","language":"Lua","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/pouyanh.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":"2018-12-18T11:37:24.000Z","updated_at":"2024-02-10T23:50:14.000Z","dependencies_parsed_at":"2023-06-11T11:45:40.036Z","dependency_job_id":null,"html_url":"https://github.com/pouyanh/carrot","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pouyanh%2Fcarrot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pouyanh%2Fcarrot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pouyanh%2Fcarrot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pouyanh%2Fcarrot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pouyanh","download_url":"https://codeload.github.com/pouyanh/carrot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242805504,"owners_count":20187996,"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":["awesomewm","lua"],"created_at":"2024-07-29T16:59:43.322Z","updated_at":"2026-01-17T13:05:55.795Z","avatar_url":"https://github.com/pouyanh.png","language":"Lua","funding_links":[],"categories":["Configuration Related"],"sub_categories":["Projects that Ease Configuration"],"readme":"# :carrot: Carrot awesomeWM personalization application\n* Do you want to have a __light__ and __geeky__ desktop environment, full of tiny widgets, on your linux?\n* Have you ever wondered if you could configure [awesomeWM][awesomewm]\nwithout learning [lua][lua]\nand reading [awful][awful] documents?\n\n__Thanks God__, for creating :carrot:\n\n# Contents\n* [Features](#features)\n* [Installation](#installation)\n * [Prerequisites](#prerequisites)\n * [AUR (Arch User Repository)](#aur-arch-user-repository)\n * [luarocks](#luarocks)\n * [git](#git)\n* [Usage](#usage)\n* [Configuration](#configuration)\n* [Todo](#todo)\n* [License](#license)\n\n# Features\n* Lets awesomeWM to become configured using a lua agnostic configuration file like this:\n\n```\nTHEME zenburn\nWALLPAPER /usr/share/awesome/themes/default/background.png\nTAGS WEB, IDE, TERM, FILE, 5, 6, 7, BOOK, MUSIC, WINE, GAME, 12\n\nAPPS.TERMINAL terminator\nAPPS.GEDITOR gvim\n\nWIBARS.AWBAR.POSITION top\nWIBARS.AWBAR.WIDGETS launcher, taglist, promptbox, carrot_battery, keyboardlayout, systray, textclock\n\nWIBARS.TASKBAR.POSITION bottom\nWIBARS.TASKBAR.WIDGETS tasklist, layoubox\n\nAUTOSTARTS.IDE.COMMAND emacs\nAUTOSTARTS.IDE.TAGS IDE\n\nAUTOSTARTS.PASYSTRAY.COMMAND pasystray\nAUTOSTARTS.BLUEMAN.COMMAND blueman-applet\n\nAUTOSTARTS.TERM.COMMAND terminator\nAUTOSTARTS.TERM.TAGS TERM, 6, 7\n```\n\n# Installation\n## Prerequisites\nFirst you need to use [awesomeWM][awesomewm] as your window manager\n\n## AUR (Arch User Repository)\nIf you're using [Arch Linux][archlinux] install [awesome-carrot][aur-awesome-carrot]\npackage from [AUR][aur]\n\n## luarocks\nInstall Carrot using lua package manager, [luarocks][luarocks]:\n\n```shell\nsudo luarocks install carrot\n```\n\n## git\nClone Carrot project into awesome configuration directory: ~/.config/awesome/\n\n```shell\ncd ~/.config/awesome\ngit clone https://github.com/pouyanh/carrot.git\n```\n\n# Usage\n1. Start Carrot in awesomeWM config file: `~/.config/awesome/rc.lua`\n\n```lua\nlocal Carrot = require(\"carrot\")\n\nCarrot.Start()\n\n-- Nothing more is needed for normal usage in rc.lua\n```\n\n2. Write configurations beside awesomeWM config file in: `~/.config/awesome/config`\n\n```\nTHEME multicolor\n```\n\nConfiguration is discussed in [Configuration](#configuration)\n\n# Configuration\n\n| Parameter | Description | Type | Default | Example |\n|-------------------|------------------------------|----------------------|-------------------------------|--------------------------------------------------|\n| THEME | Theme name | string | default | zenburn |\n| WALLPAPER | Background image filepath | string | (empty) | /usr/share/awesome/themes/default/background.png |\n| MOD | Primary modifier key | string | Mod4 | Mod4 |\n| ALT | Secondary modifier key | string | Mod1 | Mod1 |\n| TAGS | Ordered list of tags | []string | 1, 2, 3, 4, 5, 6, 7, 8, 9 | WEB, IDE, TERM, FILE, BOOK, MUSIC, WINE, GAME |\n| TAGSEL | Tag selector key group | KeyGroup | NUMROW | FUNCTION |\n| APPS | Default applications | AppList | { | { |\n| APPS.TERMINAL | Default console/terminal | string | \"terminal\": \"uxvt\", | \"terminal\": \"terminator\", |\n| APPS.EDITOR | Default console editor | string | \"editor\": $EDITOR or \"vim\", | \"editor\": \"nano\", |\n| APPS.GEDITOR | Default gui editor | string | \"geditor\": \"atom\", | \"geditor\": \"atom\", |\n| APPS.BROWSER | Default internet browser | string | \"browser\": \"firefox\", | \"browser\": \"chromium\", |\n| APPS.EXPLORER | Default file explorer | string | \"explorer\": \"thunar\", | \"explorer\": \"spacefm\", |\n| APPS.LOCKER | Default screen locker | string | \"locker\": \"slock\", | \"locker\": \"xsecurelock\" |\n| APPS.SHOTER | Default screen capturer | string | \"shoter\": \"scrot\" | \"shoter\": \"deepin-screenshot\" |\n| | | | } | } |\n| WIBARS | Screens widget bars | map[string]Wibar | { | |\n| | | | \"top\": { | |\n| | | | \"layout\": ABC | |\n| | | | \"position\": TOP | |\n| | | | \"widgets\": [ | |\n| | | | \"launcher\", | |\n| | | | \"taglist\", | |\n| | | | \"promptbox\", | |\n| | | | \"carrot_battery\", | |\n| | | | \"keyboardlayout\", | |\n| | | | \"systray\", | |\n| | | | \"textclock\" | |\n| | | | ] | |\n| | | | } | |\n| | | | } | |\n| AUTOSTARTS | Apps would run on startup | map[string]App | {} | |\n\n## Types\n\n| Type | Description | Definition | Example |\n|-----------|---------------------------------|-------------------------------------|--------------------------------------------------|\n| KeyGroup | | NUMROW \\| FUNCTION \\| NUMPAD | |\n| Layout | | | |\n| Position | | TOP \\| BOTTOM \\| LEFT \\| RIGHT | |\n| AppList | | { | |\n| | | \"terminal\": string, | |\n| | | \"editor\": string, | |\n| | | \"geditor\": string, | |\n| | | \"browser\": string, | |\n| | | \"explorer\": string, | |\n| | | \"locker\": string, | |\n| | | \"shoter\": string | |\n| | | } | |\n| Wibar | A widget bar | { | |\n| | | \"layout\": Layout, | |\n| | | \"position\": Position, | |\n| | | \"widgets\": []string | |\n| | | } | |\n| App | An application | { | |\n| | App run command | \"command\": string, | |\n| | List of bounded tags to app | \"tags\": []string | |\n| | | } | |\n\n# Todo\n1. Customize wallpaper\n2. Fully customizable wibars\n3. Autostart applications with default tags\n4. Activate tags using one of number or function keys\n\n# License\nThis software is [licensed](LICENSE) under the [GPL v3 License][gpl]. © 2018 [Janstun][janstun]\n\n[janstun]: http://janstun.com\n[awesomewm]: https://awesomewm.org/\n[lua]: https://www.lua.org/\n[awful]: https://awesomewm.org/doc/api/libraries/awful.layout.html\n[gpl]: https://www.gnu.org/licenses/gpl-3.0.en.html\n[archlinux]: https://www.archlinux.org/\n[aur-awesome-carrot]: https://aur.archlinux.org/packages/awesome-carrot \n[aur]: https://wiki.archlinux.org/index.php/AUR\n[luarocks]: https://luarocks.org/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpouyanh%2Fcarrot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpouyanh%2Fcarrot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpouyanh%2Fcarrot/lists"}