$ pipx install --include-deps ansible
You can install the minimal ansible-core package:
$ pipx install ansible-core
Alternately, you can install a specific version of ansible-core:
$ pipx install ansible-core==2.12.3
To upgrade an existing Ansible installation to the latest released version:
$ pipx upgrade --include-injected ansible
To install additional python dependencies that may be needed, with the example of installing the argcomplete python package as described below:
$ pipx inject ansible argcomplete
Include the --include-apps option to make apps in the additional python dependency available on your PATH. This allows you to execute commands for those apps from the shell.
$ pipx inject --include-apps ansible argcomplete
If you need to install dependencies from a requirements file, for example when installing the Azure collection, you can use runpip.
$ pipx runpip ansible install -r ~/.ansible/collections/ansible_collections/azure/azcollection/requirements.txt
Locate and remember the path to the Python interpreter you wish to use to run Ansible. The following instructions refer to this Python as python3.
For example, if you have determined that you want the Python at /usr/bin/python3.9 to be the one that you will install Ansible under, specify that instead of python3.
To verify whether pip is already installed for your preferred Python:
$ python3 -m pip -V
If all is well, you should see something like the following:
$ python3 -m pip -V
pip 21.0.1 from /usr/lib/python3.9/site-packages/pip (python 3.9)
If so, pip is available, and you can move on to the next step.
If you see an error like No module named pip, you will need to install pip under your chosen Python interpreter before proceeding.
This may mean installing an additional OS package (for example, python3-pip), or installing the latest pip directly from the Python Packaging Authority by running the following:
$ curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
$ python3 get-pip.py --user
You may need to perform some additional configuration before you are able to run Ansible. See the Python documentation on installing to the user site for more information.
Use pip in your selected Python environment to install the full Ansible package for the current user:
$ python3 -m pip install --user ansible
You can install the minimal ansible-core package for the current user:
$ python3 -m pip install --user ansible-core
Alternately, you can install a specific version of ansible-core:
$ python3 -m pip install --user ansible-core==2.12.3
To upgrade an existing Ansible installation in this Python environment to the latest released version, simply add --upgrade to the command above:
$ python3 -m pip install --upgrade --user ansible
Instead of installing Ansible content manually, you can simply build an execution environment container image or use one of the available community images as your control node.
See Getting started with Execution Environments for details.
If you are testing new features, fixing bugs, or otherwise working with the development team on changes to the core code, you can install and run the source from GitHub.
You should only install and run the devel branch if you are modifying ansible-core or trying out features under development. This is a rapidly changing source of code and can become unstable at any point.
For more information on getting involved in the Ansible project, see the Ansible Community Guide.
For more information on creating Ansible modules and Collections, see the Developer Guide.
You can install the devel branch of ansible-core directly from GitHub with pip:
$ python3 -m pip install --user https://github.com/ansible/ansible/archive/devel.tar.gz
You can replace devel in the URL mentioned above, with any other branch or tag on GitHub to install older versions of Ansible, tagged alpha or beta versions, and release candidates.
ansible-core is easy to run from source. You do not need root permissions to use it and there is no software to actually install. No daemons or database setup are required.
Clone the ansible-core repository
$ git clone https://github.com/ansible/ansible.git
$ cd ./ansible
Setup the Ansible environment
Using Bash
$ source ./hacking/env-setup
Using Fish
$ source ./hacking/env-setup.fish
To suppress spurious warnings/errors, use -q
$ source ./hacking/env-setup -q
Update the devel branch of ansible-core on your local machine
Use pull-with-rebase so any local changes are replayed.
$ git pull --rebase
You can test that Ansible is installed correctly by checking the version:
$ ansible --version
The version displayed by this command is for the associated ansible-core package that has been installed.
To check the version of the ansible package that has been installed:
$ ansible-community --version
You can add shell completion of the Ansible command line utilities by installing an optional dependency called argcomplete. It supports bash, and has limited support for zsh and tcsh.
For more information about installation and configuration, see the argcomplete documentation.
If you chose the pipx installation instructions:
$ pipx inject --include-apps ansible argcomplete
If you chose the pip installation instructions:
$ python3 -m pip install --user argcomplete
There are 2 ways to configure argcomplete to allow shell completion of the Ansible command line utilities: globally or per command.
Global completion requires bash 4.2.
$ activate-global-python-argcomplete --user
This will write a bash completion file to a user location. Use --dest to change the location or sudo to set up the completion globally.
If you do not have bash 4.2, you must register each script independently.
