Skip to main content

Ansible Scaffold

Create a clean, starter Ansible scaffold structure easily and quickly.


📈 Description

Ansible Scaffold is a lightweight CLI tool to instantly generate a fully organized Ansible project layout:

  • Inventory directory with group_vars, host_vars, and hosts
  • ansible.cfg file with sane defaults
  • Starter .gitignore
  • ssh.config ready for Ansible ssh_connection
  • Roles structure with all subfolders (tasks/, handlers/, defaults/, etc)
  • Playbooks directory
  • Facts cache directory
  • Optional default playbook creation

Perfect for automation, bootstrapping new environments, or kickstarting new projects.


🔄 Installation

pip install --user ansible-scaffold

Or clone and install locally:

git clone https://github.com/daytonjones/ansible-scaffold.git
cd ansible-scaffold
pip install --user -e .

🔄 Usage

ansible-scaffold [OPTIONS] [PATH]

If [PATH] is omitted, you will be prompted.

Options:

Option Long Description
-r --role ROLE Create a specific role (can be repeated)
-d --default-playbook NAME Create a default playbook with given name
-f --force Overwrite existing project directory without confirmation
-n --no-prompt Skip interactive prompts (fully automatic)
-t --no-tree Skip printing the generated project tree
-h --help Show this help message and exit
-v --version Show version and exit

Examples

Create an Ansible scaffold interactively:

ansible-scaffold ~/my_ansible_project

Create a scaffold with multiple roles and a starter playbook automatically:

ansible-scaffold ~/new_project -r webserver -r database -d site --force --no-prompt

👉 Features

  • Fast and clean structure generation
  • Default ansible.cfg with best practices
  • Automatic starter playbook with role entries
  • Colorized, friendly CLI prompts
  • Safe overwrite behavior with --force option
  • Full support for automation scripting

👉 License

MIT License


📢 Author

Dayton Jones
✨ PyPI Profile ✨ GitHub Profile


💡 Todo / Future Plans

  • Optional support for ansible-vault starter integration
  • Project templates (for common layouts)
  • Plugin-based architecture for customizations

Metadata

Release files for ansible-scaffold 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ansible-scaffold 1.0.0
File Size Uploaded Provenance Actions
ansible_scaffold-1.0.0.tar.gz 6.8 kB Without provenance Details for ansible_scaffold-1.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ansible-scaffold 1.0.0
File Interpreter ABI Platform Actions
ansible_scaffold-1.0.0-py3-none-any.whl Python 3 none any Details for ansible_scaffold-1.0.0-py3-none-any.whl

Total release size: 14.1 kB

Release files / ansible_scaffold-1.0.0.tar.gz

Download URL ansible_scaffold-1.0.0.tar.gz
Size 6.8 kB
Tags Source
SHA-256 checksum
How to use checksums
668797aba8cbd4fb24557edfb3482c81bcf8c37ca5695d8449a1fca04e286232
BLAKE2b-256 checksum
How to use checksums
c200dfea591d7f4a475e911bad489a3b1d0a9f4462c8617d94a641d98b5fc0a8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.3

Release files / ansible_scaffold-1.0.0-py3-none-any.whl

Download URL ansible_scaffold-1.0.0-py3-none-any.whl
Size 7.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
076577330475ed4b5a8d8e50b7ff83f2b68f444dc2a1c62170590e086ff5e8d7
BLAKE2b-256 checksum
How to use checksums
87705987b79f258f735c09c330ae12c371f34d09151f97a396b1c525620f1150
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.3

Security for ansible-scaffold 1.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page