https://github.com/ansible/ansible-creator

The fastest way to generate all your ansible content!
https://github.com/ansible/ansible-creator

ansible ansible-devtools content developer-tools hacktoberfest scaffolding

Last synced: 6 days ago
JSON representation

The fastest way to generate all your ansible content!

• Host: GitHub
• URL: https://github.com/ansible/ansible-creator
• Owner: ansible
• License: apache-2.0
• Created: 2023-07-26T11:43:20.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-01-19T06:54:08.000Z (14 days ago)
• Last Synced: 2025-01-19T18:04:06.437Z (13 days ago)
• Topics: ansible, ansible-devtools, content, developer-tools, hacktoberfest, scaffolding
• Language: Python
• Homepage: https://ansible.readthedocs.io/projects/creator/
• Size: 9.38 MB
• Stars: 91
• Watchers: 10
• Forks: 31
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: docs/contributing.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
[![codecov](https://codecov.io/github/ansible/ansible-creator/graph/badge.svg?token=QZKqxsNNsL)](https://codecov.io/github/ansible/ansible-creator)

[![PyPI - Status](https://img.shields.io/pypi/status/ansible-creator)](https://pypi.org/project/ansible-creator/)

[![PyPI - Version](https://img.shields.io/pypi/v/ansible-creator)](https://pypi.org/project/ansible-creator/)

![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ansible-creator)

![License](https://img.shields.io/github/license/ansible/ansible-creator)

[![Ansible Code of Conduct](https://img.shields.io/badge/Code%20of%20Conduct-Ansible-silver.svg)](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html)

[![GitHub issues](https://img.shields.io/github/issues/ansible/ansible-creator)](https://github.com/ansible/ansible-creator/issues)

# ansible-creator

A CLI tool for scaffolding all your Ansible Content.

## Installation

```shell

pip install ansible-creator

```

```shell

$ ansible-creator --help

usage: ansible-creator [-h] command ...

The fastest way to generate all your ansible content.

Positional arguments:

 command

  add           Add resources to an existing Ansible project.

  init          Initialize a new Ansible project.

Options:

 --version      Print ansible-creator version and exit.

 -h     --help  Show this help message and exit

```

## Usage

Full documentation on how to use `ansible-creator`, including integration with the VS Code Ansible Extension, is available in

[ansible-creator documentation](https://ansible.readthedocs.io/projects/creator/).

## Command line completion

`ansible-creator` has experimental command line completion for common shells. Please ensure you have the `argcomplete` package installed and configured.

```shell

pip install argcomplete --user

activate-global-python-argcomplete --user

```

## Upcoming features

- Scaffold Ansible plugins of your choice with the `create` action.

  Switch to the [create](https://github.com/ansible-community/ansible-creator/tree/create) branch and try it out!

## Communication

Refer to the [Get in Touch](https://ansible.readthedocs.io/projects/creator/contributing/#get-in-touch)

section of the Contributor Guide to find out how to communicate with us.

You can also find more information in the

[Ansible communication guide](https://docs.ansible.com/ansible/devel/community/communication.html).

## Contributing

See [Contributing to ansible-creator](https://ansible.readthedocs.io/projects/creator/contributing/).

## Code of Conduct

Please see the

[Ansible Community Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html).

## Licensing

ansible-creator is released under the Apache License version 2.

See the [LICENSE](https://github.com/ansible/ansible-creator/blob/main/LICENSE) file for more details.