nekeal.zsh

Ansible Role: Zsh

This Ansible role sets up zsh, zinit, and some shell tools.

Requirements

Supported Operating Systems:

Debian 11
Debian 10
Debian 9
Ubuntu 18
Ubuntu 20

Role Variables

Name	Default Value	Description
`zsh_version`	5.8	The version of zsh to install
`zsh_reinstall_from_source`	false	Should we reinstall zsh, even if the version is the same as what is currently installed?
`zsh_install_bin_prefix`	/bin	Where to store the zsh binary
`zsh_user_config_dir`	.zsh	Where to save and load zsh configuration files (relative to the user's home directory)
`zsh_install_zinit`	true	Should we install the zinit plugin manager?
`zsh_install_templates`	true	Should we install zsh templates like .zshrc?
`zsh_zshrc_template`	zshrc-default.zsh.j2	Default template for the .zshrc file
`zsh_aliases_template`	aliases-default.zsh.j2	Default template for the aliases file
`zsh_zinit_plugins_template`	zinit-plugins-default.zsh.j2	Default template for zinit plugins. It includes useful plugins and some configurations from ohmyzsh
`zshenv_template`	zshenv-default.j2	Default template for the ~/.zshenv file
`users`	[]	List of users to configure for zsh

Example user configuration:

users:
  - username: admin
    shell: /bin/zsh
    aliases:
      aliases:
        l: ls -lart
    zshrc:
      template: zshrc-default.zsh.j2
    env_vars:
      PATH: "$PATH=~/.local/bin:$PATH"
    zsh_config_templates:
      - src: extra-config-template.zsh.j2
        dest: .zsh/config.zsh

The default zshrc template gathers common files from ~ and ~/.zsh, along with any extra templates. It also supports zinit, fzf, and powerlevel10k by default.

Dependencies

Roles:

nekeal.users - Uses the same users list as this role. The shell key must be set to /bin/zsh.

Example:

users:
  - username: admin
    shell: /bin/zsh

Example Playbook

- hosts: servers
  roles:
     - { role: nekeal.zsh }

License

MIT

Author Information

Nekeal

Informazioni sul progetto

Ansible role which configures zsh, zinit and some shell tools

role

Installa

ansible-galaxy install nekeal.zsh

GitHub repository

3 stelle

2 fork

1 problemi aperti

Licenza

mit

Download

143

Proprietario

Szymon Cader