Interactive Playground

The Examples Plugin

The Examples plugin provides a safe, interactive environment to explore Provisioner’s capabilities without making any system changes. It demonstrates the framework’s user interface patterns, command structures, and interactive features.

Getting Started

Installation

First, install the Examples plugin:

pip install provisioner-examples-plugin

This plugin adds several demonstration commands to your Provisioner installation, all designed to be completely safe to run.

Exploring Commands

After installation, explore the available example commands:

provisioner examples --help

You’ll see several command groups:

• ansible - Demonstrates localhost Ansible integration patterns
• anchor - Interact with an OSS tool

Running Example Commands

Basic Ansible Example

Try the “hello” command to see a basic Ansible integration example:

provisioner examples ansible hello

This command simulates an Ansible execution without actually modifying your system. It demonstrates:

• Command parameter handling
• Execution workflow visualization
• Success/failure reporting

Using Dry Run Mode

Provisioner includes a powerful “dry run” mode that shows what a command would do without actually executing it. This is especially useful for understanding complex commands before running them.

To use dry run mode, add the --dry-run flag (or -d for short):

provisioner examples ansible hello --dry-run

For more detailed output, combine with the verbose flag:

provisioner examples ansible hello --dry-run --verbose

This will display:

• Command hierarchy and structure
• Parameter values and sources
• Mock execution steps
• Validation checks