{"id":13558495,"url":"https://github.com/gantsign/ansible_role_antigen","last_synced_at":"2026-02-18T12:01:34.678Z","repository":{"id":39652658,"uuid":"143513876","full_name":"gantsign/ansible_role_antigen","owner":"gantsign","description":"Ansible role for installing the Antigen and using it to configure Zsh","archived":false,"fork":false,"pushed_at":"2022-08-28T19:45:18.000Z","size":108,"stargazers_count":27,"open_issues_count":6,"forks_count":16,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-06T17:37:33.707Z","etag":null,"topics":["ansible","ansible-role","antigen","oh-my-zsh","zsh"],"latest_commit_sha":null,"homepage":"https://galaxy.ansible.com/gantsign/antigen","language":"Shell","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/gantsign.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}},"created_at":"2018-08-04T09:03:03.000Z","updated_at":"2023-09-18T23:56:04.000Z","dependencies_parsed_at":"2022-08-09T15:08:49.043Z","dependency_job_id":null,"html_url":"https://github.com/gantsign/ansible_role_antigen","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/gantsign/ansible_role_antigen","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gantsign%2Fansible_role_antigen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gantsign%2Fansible_role_antigen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gantsign%2Fansible_role_antigen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gantsign%2Fansible_role_antigen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gantsign","download_url":"https://codeload.github.com/gantsign/ansible_role_antigen/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gantsign%2Fansible_role_antigen/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29578144,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-18T08:38:15.585Z","status":"ssl_error","status_checked_at":"2026-02-18T08:38:14.917Z","response_time":162,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["ansible","ansible-role","antigen","oh-my-zsh","zsh"],"created_at":"2024-08-01T12:04:59.083Z","updated_at":"2026-02-18T12:01:34.662Z","avatar_url":"https://github.com/gantsign.png","language":"Shell","funding_links":[],"categories":["Shell","ansible"],"sub_categories":[],"readme":"Ansible Role: Antigen\n=====================\n\n[![Tests](https://github.com/gantsign/ansible_role_antigen/workflows/Tests/badge.svg)](https://github.com/gantsign/ansible_role_antigen/actions?query=workflow%3ATests)\n[![Ansible Galaxy](https://img.shields.io/badge/ansible--galaxy-gantsign.antigen-blue.svg)](https://galaxy.ansible.com/gantsign/antigen)\n[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/gantsign/ansible_role_antigen/master/LICENSE)\n\nRole to install the [Antigen](http://antigen.sharats.me/) plugin manger for Zsh\nand use it to configure Zsh.\n\nThis role has a companion role that enables you to conditionally install\nparticular Antigen bundles. You can find details of that role at\n[gantsign.antigen_budles](https://galaxy.ansible.com/gantsign/antigen_bundles).\n\n:thumbsdown: Deprecation Notice :thumbsdown:\n--------------------------------------------\nThe last Antigen release was\n[v2.2.3](https://github.com/zsh-users/antigen/releases/tag/v2.2.3) on 4 Jan\n2018. This role actually uses\n[v2.0.2](https://github.com/zsh-users/antigen/releases/tag/v2.0.2) (22 Apr 2017)\ndue to issues with later versions and some Oh My Zsh plugins. Since Antigen\nappears to no longer be maintained, we recommend against using this role. This\nrole will continue to be maintained until such time as GantSign migrates to a\ndifferent Zsh plugin manager.\n\nRequirements\n------------\n\n* Ansible \u003e= 2.9\n\n* Linux Distribution\n\n    * Debian Family\n\n        * Debian\n\n            * Stretch (9)\n            * Buster (10)\n            * Bullseye (11)\n\n        * Ubuntu\n\n            * Bionic (18.04)\n            * Focal (20.04)\n\n    * RedHat Family\n\n        * Rocky Linux\n\n            * 8\n\n        * Fedora\n\n            * 35\n\n    * SUSE Family\n\n        * openSUSE\n\n            * 15.3\n\n    * Note: other versions are likely to work but have not been tested.\n\nRole Variables\n--------------\n\nThe following variables will change the behavior of this role:\n\n```yaml\n# Antigen version number\nantigen_version: '2.0.2'\n\n# SHA256 sum for the redistributable package\nantigen_redis_sha256sum: 'f47ec933b32c578abe8cb39b24e0ddd114ef5cc01b3c05bcb634859ead31493f'\n\n# Should Oh-My-Zsh be installed with Antigen (doesn't call `antigen use`)\nantigen_install_oh_my_zsh: yes\n\n# Mirror location for Antigen download\nantigen_redis_mirror: 'https://github.com/zsh-users/antigen/releases/download/v{{ antigen_version }}'\n\n# Directory to store files downloaded for Antigen installation on the remote box\nantigen_download_dir: \"{{ x_ansible_download_dir | default(ansible_env.HOME + '/.ansible/tmp/downloads') }}\"\n\n# Antigen is installed per user so you need to specify the users to install it for\nusers:\n  - username: # The username of the user to install Antigen for\n    antigen_libraries:\n      - name: # The name of the library (e.g. oh-my-zsh or prezto) must be unique\n        url: # Optional. If you're using a custom library you must specify the Git URL\n        args: # Optional. Command line arguments to pass to Antigen\n          - '--exampleParam1'\n          - 'paramValue1' # example with value passed as a separate arg\n          - '--exampleParam2=paramValue2' # example with value passed in the same arg\n        env: # Optional. Environnement variables to set\n          EXAMPLE_ENV1: 'envValue1'\n          EXAMPLE_ENV2: '\"${HOME}/.example\"' # the single quotes are for YAML the double quotes are for the shell\n      # more libraries here\n    antigen_theme:\n      name: # The name of the library (e.g. one of the themes that come with Oh-My-Zsh)\n      url: # Optional. If the theme doesn't come with Oh-My-Zsh you must specify the Git URL\n      env: {} # Optional. Environnement variables to set\n    antigen_bundles:\n      - name: # The name of the Antigen bundle (e.g. one of the plugins that come with Oh-My-Zsh)\n        url: # Optional. If the it's not one of the Oh-My-Zsh plugins you must specify the URL (use owner/repo shorthand for GitHub)\n        location: # Optional. The directory in the repository containing the plugin\n        branch: # Optional. Git branch to checkout.\n        tag: # Optional. Git tag to checkout (takes preference over branch)\n        args: [] # Optional. Command line arguments to pass to Antigen\n        env: {} # Optional. Environnement variables to set\n      # more bundles here\n  # more users here\n```\n\nExample Playbooks\n-----------------\n\nThe following achieves the same as the example in the Antigen\n[README.mkd](https://github.com/zsh-users/antigen/blob/develop/README.mkd#usage).\n\n```yaml\n- hosts: servers\n  roles:\n    - role: gantsign.antigen\n      users:\n        - username: example\n          antigen_libraries:\n            - name: oh-my-zsh\n          antigen_theme:\n            name: robbyrussell\n          antigen_bundles:\n            # Bundles from the default repo (robbyrussell's oh-my-zsh).\n            - name: git\n            - name: heroku\n            - name: pip\n            - name: lein\n            - name: command-not-found\n            # Syntax highlighting bundle.\n            - name: zsh-syntax-highlighting # `name` is required (any valid file name will do so long as it's unique for the bundles)\n              url: zsh-users/zsh-syntax-highlighting\n```\n\nThe following achieves the same as the example in the `gantsign.oh-my-zsh` role\n[README.md](https://github.com/gantsign/ansible-role-oh-my-zsh/blob/master/README.md#example-playbook)\n\n```yaml\n- hosts: servers\n  roles:\n    - role: gantsign.antigen\n      users:\n        - username: example\n          antigen_libraries:\n            - name: oh-my-zsh\n              env:\n                DISABLE_AUTO_UPDATE: '\"true\"' # Optional (this was hard-coded in the .zshrc of the `gantsign.oh-my-zsh` role)\n          antigen_theme:\n            name: robbyrussell # This role has no default theme (unlike the `gantsign.oh-my-zsh` role)\n          antigen_bundles:\n            - name: git # This role has no default bundles/plugins (unlike the `gantsign.oh-my-zsh` role)\n```\n\nMore Roles From GantSign\n------------------------\n\nYou can find more roles from GantSign on\n[Ansible Galaxy](https://galaxy.ansible.com/gantsign).\n\nDevelopment \u0026 Testing\n---------------------\n\nThis project uses [Molecule](http://molecule.readthedocs.io/) to aid in the\ndevelopment and testing; the role is unit tested using\n[Testinfra](http://testinfra.readthedocs.io/) and\n[pytest](http://docs.pytest.org/).\n\nTo develop or test you'll need to have installed the following:\n\n* Linux (e.g. [Ubuntu](http://www.ubuntu.com/))\n* [Docker](https://www.docker.com/)\n* [Python](https://www.python.org/) (including python-pip)\n* [Ansible](https://www.ansible.com/)\n* [Molecule](http://molecule.readthedocs.io/)\n\nBecause the above can be tricky to install, this project includes\n[Molecule Wrapper](https://github.com/gantsign/molecule-wrapper). Molecule\nWrapper is a shell script that installs Molecule and it's dependencies (apart\nfrom Linux) and then executes Molecule with the command you pass it.\n\nTo test this role using Molecule Wrapper run the following command from the\nproject root:\n\n```bash\n./moleculew test\n```\n\nNote: some of the dependencies need `sudo` permission to install.\n\nLicense\n-------\n\nMIT\n\nAuthor Information\n------------------\n\nJohn Freeman\n\nGantSign Ltd.\nCompany No. 06109112 (registered in England)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgantsign%2Fansible_role_antigen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgantsign%2Fansible_role_antigen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgantsign%2Fansible_role_antigen/lists"}