Ansible-keyring NPM

subheader_description

Overview

This repository is home to ansible-keyring a CLI that extends the ansible, ansible-playbook, and ansible-vault command to retrieve vault passwords from the system keyring. It is based on the work of ansible-tools with a couple usability improvements. The features it adds are:

Does not have to be run only in directories where ansible.cfg is present
New, shorter, more intuitive command aliases

Installation

To accomodate everyone, this CLI can be installed using a variety of methods.

PyPi

If you already have Python 3 and pip3 installed, you can install the CLI by running:

pip3 install {{(if customPyPiPackageName customPyPiPackageName (append repository.prefix.github slug))}}

Install Doctor

On macOS or Linux, you can run:

bash -sS https://install.doctor/py/{{(if customPyPiPackageName customPyPiPackageName (append repository.prefix.github slug))}}

And on Windows, you can run:

Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://install.doctor/py/{{(if customPyPiPackageName customPyPiPackageName (append repository.prefix.github slug))}}?os=win'))

Homebrew

If you have Homebrew installed, you can install the package by running:

brew install installdoc/py/{{(if customPyPiPackageName customPyPiPackageName (append repository.prefix.github slug))}}

Or if you prefer to keep Python off your system, and install a binary, you can run:

brew install installdoc/py/{{(if customPyPiPackageName customPyPiPackageName (append repository.prefix.github slug))}}-binary

Chocolatey

If you are on Windows, you can install a binary version (without the Python dependency), using Chocolatey:

choco install {{(if customPyPiPackageName customPyPiPackageName (append repository.prefix.github slug))}}

Binary Releases

There are also binaries (in various formats) available for download on both GitHub and GitLab.

Requirements

To run this project, all you need is Python 3 and pip3. See the Installation section for instructions that include alternate installation methods that do not require Python to be installed.

If you are interested in contributing or would like to make some modifications, please see the CONTRIBUTING guide. There are a handful of build tools we incorporate into the development process. All of them are installed automatically via our Taskfile system. You can get started customizing this project by running:

bash .config/scripts/start.sh
task start
task --list

Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page. If you would like to contribute, please take a look at the contributing guide.

Brian Zalewski