{"id":13639984,"url":"https://github.com/anki-code/xontrib-rc-awesome","last_synced_at":"2025-12-30T21:57:47.184Z","repository":{"id":37633123,"uuid":"300561322","full_name":"anki-code/xontrib-rc-awesome","owner":"anki-code","description":"👓 🐚 Make your xonsh RC file installable with awesome snippets of code.","archived":false,"fork":false,"pushed_at":"2024-05-16T10:57:47.000Z","size":232,"stargazers_count":74,"open_issues_count":2,"forks_count":12,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-05-22T06:56:10.057Z","etag":null,"topics":["awesome","awesome-config","awesome-shell","awesome-xonsh","cli","console","iterm2","linux","mac","macos","terminal","xonsh","xonshrc","xontrib"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/anki-code.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":null,"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},"funding":{"custom":["https://github.com/anki-code","https://www.buymeacoffee.com/xxh","https://github.com/xonsh/xonsh#the-xonsh-shell-community"]}},"created_at":"2020-10-02T09:12:16.000Z","updated_at":"2024-06-01T09:14:06.746Z","dependencies_parsed_at":"2024-03-18T22:01:01.397Z","dependency_job_id":"bc97b52d-a24d-42e2-99b1-641b2f2a4299","html_url":"https://github.com/anki-code/xontrib-rc-awesome","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anki-code%2Fxontrib-rc-awesome","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anki-code%2Fxontrib-rc-awesome/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anki-code%2Fxontrib-rc-awesome/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anki-code%2Fxontrib-rc-awesome/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/anki-code","download_url":"https://codeload.github.com/anki-code/xontrib-rc-awesome/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238574748,"owners_count":19494725,"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":["awesome","awesome-config","awesome-shell","awesome-xonsh","cli","console","iterm2","linux","mac","macos","terminal","xonsh","xonshrc","xontrib"],"created_at":"2024-08-02T01:01:06.741Z","updated_at":"2025-12-30T21:57:47.178Z","avatar_url":"https://github.com/anki-code.png","language":"Python","funding_links":["https://github.com/anki-code","https://www.buymeacoffee.com/xxh","https://github.com/xonsh/xonsh#the-xonsh-shell-community"],"categories":["See also"],"sub_categories":["pytest: xonsh not found"],"readme":"\u003cp align=\"center\"\u003e\nAwesome snippets of code for xonshrc in xonsh shell. \n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\nIf you like the idea click ⭐ on the repo and \u003ca href=\"https://twitter.com/intent/tweet?text=The%20xonsh%20shell%20awesome%20rc%20file!\u0026url=https://github.com/anki-code/awesome-xonshrc\" target=\"_blank\"\u003etweet\u003c/a\u003e.\n\u003c/p\u003e\n\n### First of all\n\nLearn about xonsh run control (RC) files in official docs - [Run Control File](https://xon.sh/xonshrc.html). You should know about what RC files are used in interactive and non-interactive sessions.\n\n### Use cases\n\n#### Create your own pip-installable RC based on the awesome xonsh RC\n\n1. Fork this repository\n2. Rename the repository to `xontrib-rc-yourname`\n3. Change the name [in setup.py](https://github.com/anki-code/xontrib-rc-awesome/blob/e21370c1155262b8e25bd354cb4d4f9f15945384/setup.py#L11)\n4. Change the name of `xontrib/rc_awesome.xsh` to `xontrib/rc_yourname.xsh`\n5. [Add xontribs you need to setup.py](https://github.com/anki-code/xontrib-rc-awesome/blob/495dce4c8e7e8c9882ea002db60935d03f3fb861/setup.py#L20-L38) (the xontribs will be installed automatically during `pip install`)\n6. Now you can just run anywhere:\n    ```xonsh\n    pip install -U git+https://github.com/yourname/xontrib-rc-yourname\n\n    # Only for interactive mode:\n    # (You can also create autoloadable xontrib using xontrib-template. See below.)\n    echo 'xontrib load rc_yourname' \u003e\u003e ~/.xonshrc\n\n    # For interactive or non-interactive (https://xon.sh/xonshrc.html):\n    # mkdir -p ~/.config/xonsh/rc.d/\n    # echo 'xontrib load rc_yourname' \u003e ~/.config/xonsh/rc.d/rc_yourname.xsh\n\n    xonsh\n    ```\n    Also you can avoid manual loading the xontrib in `~/.xonshrc` by creating autoloadable xontrib using [xontrib-template](https://github.com/xonsh/xontrib-template). Answer yes on the question about enabling autoloading.\n    \n7. [Increment version](https://github.com/anki-code/xontrib-rc-awesome/blob/df5c0aa3e29325f5d926cec7022cd2ccc184c0c5/setup.py#L12) to update the package using `pip install -U git+https://github.com/yourname/xontrib-rc-yourname`\n\n8. Take a look into [xonsh-awesome-cli-app](https://github.com/anki-code/xonsh-awesome-cli-app) if you want to create your own toolset.\n\n#### Copy and paste\n\nJust read [rc_awesome](https://github.com/anki-code/xontrib-rc-awesome/blob/main/xontrib/rc_awesome.xsh) and copy the snippets to your xonsh RC.\n\nOr add awesome xonsh RC to the end of your [xonshrc](https://xon.sh/xonshrc.html):\n```\ncurl -s https://raw.githubusercontent.com/anki-code/xontrib-rc-awesome/main/xontrib/rc_awesome.xsh \u003e\u003e ~/.xonshrc\n```\n\nOr install awesome [xonsh RC as a package](https://github.com/anki-code/xontrib-rc-awesome/blob/fabe895fbdd89f7bd3050bf492aa0665624a9705/setup.py#L10-L16) with [automatically installable xontribs](https://github.com/anki-code/xontrib-rc-awesome/blob/fabe895fbdd89f7bd3050bf492aa0665624a9705/setup.py#L20-L30):\n```xonsh\npip install -U git+https://github.com/anki-code/xontrib-rc-awesome\necho 'xontrib load rc_awesome' \u003e\u003e ~/.xonshrc\nxonsh\n```\n\n#### Learn from xonsh RC gurus\n\n* [Anthony Scopatz RC](https://github.com/xonsh/xonsh/pull/3917#issuecomment-715649009) (click Details to see the xonshrc)\n* [Sean Farley RC](https://github.com/seanfarley/dotfiles/blob/c87811f50cd696a8d4ddce83c1ca295a00b70218/xonshrc)\n* [Gyuri Horak RC](https://github.com/dyuri/rcfiles/blob/master/.xonshrc)\n* [Jason RC](https://github.com/jaraco/jaraco.xonsh)\n* [Alexander Sosedkin RC](https://github.com/t184256/nix-configs/tree/main/user/xonsh/config)\n* [Noorhteen Raja NJ RC](https://github.com/jnoortheen/xonfig)\n* [Ryan Delaney RC](https://github.com/rpdelaney/dotfiles/tree/main/home/.config/xonsh)\n\n\n### See also\n* [xonsh-cheatsheet](https://github.com/anki-code/xonsh-cheatsheet/blob/main/README.md) - cheat sheet for xonsh shell with copy-pastable examples.\n* [xontrib-template](https://github.com/xonsh/xontrib-template) - Full-featured template for building extension (xontrib) for the xonsh shell.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanki-code%2Fxontrib-rc-awesome","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fanki-code%2Fxontrib-rc-awesome","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanki-code%2Fxontrib-rc-awesome/lists"}