### Example: Initialize Ansible Execution Environment Project

Source: https://docs.ansible.com/projects/creator/installing?q=

This example shows how to initialize an execution environment project in the specified home directory.

```bash
ansible-creator init execution_env $HOME/ansible-projects/ee-project

```

--------------------------------

### Example: Add Devcontainer Resource to Project

Source: https://docs.ansible.com/projects/creator/installing?q=

This example demonstrates how to add devcontainer files to an existing project located at the specified path.

```bash
ansible-creator add resource devcontainer /home/user/..path/to/your/existing_project

```

--------------------------------

### Install and Activate Command Line Completion

Source: https://docs.ansible.com/projects/creator/installing

Installs the argcomplete package for command-line completion and activates it globally for the user. Ensure argcomplete is installed and configured.

```bash
pip install argcomplete --user
activate-global-python-argcomplete --user
```

--------------------------------

### Clone and Branch for Contribution

Source: https://docs.ansible.com/projects/creator/contributing

Clone the repository recursively, checkout a new branch, and prepare for coding. This is the initial setup for making contributions.

```bash
git clone --recursive git@github.com:your-name/ansible-creator
cd ansible-creator
git checkout -b your-branch-name
```

--------------------------------

### Get Ansible Creator Add Subcommand Help

Source: https://docs.ansible.com/projects/creator/installing

Run `ansible-creator add --help` to display available commands and options for the `add` subcommand. This is useful for understanding how to scaffold content types.

```bash
ansible-creator add --help

```

--------------------------------

### Install Ansible Development Tools

Source: https://docs.ansible.com/projects/creator/installing

Installs the ansible-dev-tools package, which includes ansible-creator and other essential Ansible development tools. This also installs ansible-core if not already present.

```bash
pip3 install ansible-dev-tools
```

--------------------------------

### Install Ansible Creator

Source: https://docs.ansible.com/projects/creator/installing

Installs the ansible-creator package directly using pip.

```bash
pip install ansible-creator
```

--------------------------------

### Configure Python and system dependencies via JSON

Source: https://docs.ansible.com/projects/creator/ee_scaffolding?q=

Specify Python and system packages to be installed in the Execution Environment using JSON configuration.

```json
{
  "python_deps": ["jmespath", "boto3"],
  "system_packages": ["openssh-clients", "sshpass"]
}

```

--------------------------------

### Generated ansible.cfg for Galaxy servers

Source: https://docs.ansible.com/projects/creator/ee_scaffolding?q=

This is an example of an `ansible.cfg` file generated by `ansible-creator` when `galaxy_servers` are configured. It includes server lists and token requirements.

```ini
[galaxy]
server_list = automation_hub, private_hub, galaxy

[galaxy_server.automation_hub]
url = https://console.redhat.com/api/automation-hub/content/published/
auth_url = https://sso.redhat.com/auth/realms/redhat-external/protocol/openid-connect/token
# Token: set ANSIBLE_GALAXY_SERVER_AUTOMATION_HUB_TOKEN as a repository secret

[galaxy_server.private_hub]
url = https://pah.corp.example.com/api/galaxy/content/published/
validate_certs = false

```

--------------------------------

### Generated Ansible.cfg for Galaxy Servers

Source: https://docs.ansible.com/projects/creator/ee_scaffolding

This is an example of an `ansible.cfg` file generated based on the `galaxy_servers` configuration, including server lists and token requirements.

```ini
[galaxy]
server_list = automation_hub, private_hub, galaxy

[galaxy_server.automation_hub]
url = https://console.redhat.com/api/automation-hub/content/published/
auth_url = https://sso.redhat.com/auth/realms/redhat-external/protocol/openid-connect/token
# Token: set ANSIBLE_GALAXY_SERVER_AUTOMATION_HUB_TOKEN as a repository secret

[galaxy_server.private_hub]
url = https://pah.corp.example.com/api/galaxy/content/published/
validate_certs = false
```

--------------------------------

### Initialize Execution Environment with GitHub Actions

Source: https://docs.ansible.com/projects/creator/ee_scaffolding?q=

Use this command to scaffold an execution environment project with GitHub Actions CI/CD integration. It defines base image, collections, and galaxy servers.

```bash
ansible-creator init execution_env \
  --ee-config '{
    "name": "ee-network",
    "base_image": "registry.redhat.io/ansible-automation-platform-25/ee-minimal-rhel8:latest",
    "collections": [
      {"name": "cisco.ios"},
      {"name": "ansible.netcommon"}
    ],
    "galaxy_servers": [
      {
        "id": "automation_hub",
        "url": "https://console.redhat.com/api/automation-hub/content/published/",
        "auth_url": "https://sso.redhat.com/auth/realms/redhat-external/protocol/openid-connect/token",
        "token_required": true
      },
      {
        "id": "galaxy",
        "url": "https://galaxy.ansible.com/"
      }
    ]
  }' \
  my-ee-project

```

--------------------------------

### Scaffold a new Execution Environment project

Source: https://docs.ansible.com/projects/creator/ee_scaffolding?q=

Use this command to create a new EE project with GitHub Actions as the default CI/CD provider.

```bash
ansible-creator init execution_env my-ee-project

```

--------------------------------

### Display Ansible Creator Help

Source: https://docs.ansible.com/projects/creator/installing

Shows an overview of available commands and options for the ansible-creator CLI.

```bash
ansible-creator --help
```

--------------------------------

### Initialize Ansible Collection Project

Source: https://docs.ansible.com/projects/creator/installing

Initializes a new Ansible collection project with the specified collection name and destination path. Use this command to scaffold a new collection.

```bash
ansible-creator init collection testns.testname $HOME/collections/ansible_collections
```

--------------------------------

### Scaffold Execution Environment with GitHub Actions

Source: https://docs.ansible.com/projects/creator/ee_scaffolding

Use this command to initialize an execution environment project with GitHub Actions CI/CD integration. It configures base image, collections, and galaxy servers.

```bash
ansible-creator init execution_env \
  --ee-config {
    "name": "ee-network",
    "base_image": "registry.redhat.io/ansible-automation-platform-25/ee-minimal-rhel8:latest",
    "collections": [
      {"name": "cisco.ios"},
      {"name": "ansible.netcommon"}
    ],
    "galaxy_servers": [
      {
        "id": "automation_hub",
        "url": "https://console.redhat.com/api/automation-hub/content/published/",
        "auth_url": "https://sso.redhat.com/auth/realms/redhat-external/protocol/openid-connect/token",
        "token_required": true
      },
      {
        "id": "galaxy",
        "url": "https://galaxy.ansible.com/"
      }
    ]
  } \
  my-ee-project

```

--------------------------------

### Scaffold Execution Environment Project

Source: https://docs.ansible.com/projects/creator/ee_scaffolding

Use this command to create a new EE project with default GitHub Actions CI/CD.

```bash
ansible-creator init execution_env my-ee-project
```

--------------------------------

### Initialize Ansible Execution Environment Project

Source: https://docs.ansible.com/projects/creator/installing?q=

Use this command to initialize a new Ansible execution environment project. Replace `<path>` with the desired directory for your project.

```bash
ansible-creator init execution_env <path>

```

--------------------------------

### Initialize Ansible Playbook Project Command

Source: https://docs.ansible.com/projects/creator/installing

This command initializes a new Ansible playbook project. It requires the collection name in the format `<namespace>.<name>` and the destination path for the project.

```bash
ansible-creator init playbook <collection-name> <path>
```

```bash
ansible-creator init playbook myorg.myproject $HOME/ansible-projects/playbook-project
```

--------------------------------

### Custom Build Steps and Files

Source: https://docs.ansible.com/projects/creator/ee_scaffolding

Extend the container build process using `additional_build_steps` and `additional_build_files`. Steps can be prepended or appended to various build phases.

```json
{
  "additional_build_steps": {
    "prepend_base": ["RUN mkdir -p /etc/ansible"],
    "append_final": ["COPY _build/configs/custom.cfg /etc/ansible/ansible.cfg"]
  },
  "additional_build_files": [
    {"src": "custom.cfg", "dest": "configs"}
  ]
}
```

--------------------------------

### Clone and Branch for Contribution

Source: https://docs.ansible.com/projects/creator/contributing?q=

Clone the repository, checkout a new branch, and prepare for coding. Ensure to clone recursively to include submodules.

```bash
$ git clone --recursive git@github.com:your-name/ansible-creator
$ cd ansible-creator
$ git checkout -b your-branch-name
```

--------------------------------

### Scaffold Execution Environment Project with GitLab CI

Source: https://docs.ansible.com/projects/creator/ee_scaffolding

Use the `--scm-provider gitlab` flag to scaffold a project with GitLab CI/CD instead of GitHub Actions.

```bash
ansible-creator init execution_env --scm-provider gitlab my-ee-gitlab
```

--------------------------------

### Scaffold an Execution Environment project with GitLab CI

Source: https://docs.ansible.com/projects/creator/ee_scaffolding?q=

Use the `--scm-provider gitlab` flag to generate a GitLab CI configuration instead of GitHub Actions.

```bash
ansible-creator init execution_env --scm-provider gitlab my-ee-gitlab

```

--------------------------------

### Add EE CI files to an existing project

Source: https://docs.ansible.com/projects/creator/ee_scaffolding?q=

Use this command to add CI files (e.g., for GitLab) to an existing project directory.

```bash
ansible-creator add resource ee-ci --scm-provider gitlab /path/to/project

```

--------------------------------

### Initialize Execution Environment with GitLab CI

Source: https://docs.ansible.com/projects/creator/ee_scaffolding?q=

Scaffold an execution environment project with GitLab CI integration. This command is similar to the GitHub Actions version but generates a `.gitlab-ci.yml` file instead of GitHub Actions workflows.

```bash
ansible-creator init execution_env \
  --scm-provider gitlab \
  --ee-config '{
    "name": "ee-network",
    "base_image": "registry.redhat.io/ansible-automation-platform-25/ee-minimal-rhel8:latest",
    "collections": [
      {"name": "cisco.ios"},
      {"name": "ansible.netcommon"}
    ],
    "galaxy_servers": [
      {
        "id": "automation_hub",
        "url": "https://console.redhat.com/api/automation-hub/content/published/",
        "auth_url": "https://sso.redhat.com/auth/realms/redhat-external/protocol/openid-connect/token",
        "token_required": true
      },
      {
        "id": "galaxy",
        "url": "https://galaxy.ansible.com/"
      }
    ]
  }' \
  my-ee-gitlab

```

--------------------------------

### Initialize Ansible Execution Environment Project

Source: https://docs.ansible.com/projects/creator/installing

Use the `ansible-creator init execution_env` command to scaffold a new Ansible execution environment project. Specify the desired path for the project.

```bash
ansible-creator init execution_env <path>

```

```bash
ansible-creator init execution_env $HOME/ansible-projects/ee-project

```

--------------------------------

### Raw Ansible Configuration

Source: https://docs.ansible.com/projects/creator/ee_scaffolding

Provide raw Ansible configuration as a string. This takes precedence over `galaxy_servers` configuration.

```json
{
  "ansible_cfg": "[galaxy]\nserver_list = my_server\n\n[galaxy_server.my_server]\nurl = https://galaxy.example.com/\n"
}
```

--------------------------------

### Display Ansible Playbook Project Structure

Source: https://docs.ansible.com/projects/creator/installing

Use the `tree` command to visualize the directory structure of a generated Ansible playbook project. This helps in understanding the organization of files and directories.

```bash
$ tree -la /home/user/ansible-projects/playbook-project
.
├── ansible.cfg
├── ansible-navigator.yml
├── collections
│   ├── ansible_collections
│   │   └── myorg
│   │       └── myproject
│   │           ├── README.md
│   │           └── roles
│   │               └── run
│   │                   ├── README.md
│   │                   └── tasks
│   │                       └── main.yml
│   └── requirements.yml
├── .devcontainer
│   ├── devcontainer.json
│   ├── docker
│   │   └── devcontainer.json
│   └── podman
│       └── devcontainer.json
├── devfile.yaml
├── .github
│   ├── ansible-code-bot.yml
│   └── workflows
│       └── tests.yml
├── inventory
│   ├── group_vars
│   │   ├── all.yml
│   │   └── web_servers.yml
│   ├── hosts.yml
│   └── host_vars
│       ├── server1.yml
│       ├── server2.yml
│       ├── server3.yml
│       ├── switch1.yml
│       └── switch2.yml
├── linux_playbook.yml
├── network_playbook.yml
├── README.md
├── site.yml
└── .vscode
    └── extensions.json

```

--------------------------------

### Add EE CI Files to Existing Project

Source: https://docs.ansible.com/projects/creator/ee_scaffolding

Use this command to add CI files to an existing project directory, specifying GitLab as the SCM provider.

```bash
ansible-creator add resource ee-ci --scm-provider gitlab /path/to/project
```

--------------------------------

### Commit and Push Changes

Source: https://docs.ansible.com/projects/creator/contributing?q=

Stage new files, commit changes with verbose output, and push your branch to your fork. This prepares your contribution for a pull request.

```bash
$ git add your new files
$ git commit -v
$ git push origin your-branch-name
```

--------------------------------

### Scaffold EE with Custom Base Image

Source: https://docs.ansible.com/projects/creator/ee_scaffolding

Specify a custom base image for the Execution Environment using the `--ee-base-image` flag.

```bash
ansible-creator init execution_env \
  --ee-base-image registry.redhat.io/ansible-automation-platform-25/ee-minimal-rhel8:latest \
  my-ee-project
```

--------------------------------

### Configure Python and System Dependencies via JSON

Source: https://docs.ansible.com/projects/creator/ee_scaffolding

Specify Python and system package dependencies using JSON configuration for `--ee-config`.

```json
{
  "python_deps": ["jmespath", "boto3"],
  "system_packages": ["openssh-clients", "sshpass"]
}
```

--------------------------------

### Scaffold Execution Environment with GitLab CI

Source: https://docs.ansible.com/projects/creator/ee_scaffolding

This command scaffolds an execution environment project with GitLab CI integration. It includes the same EE configuration but generates a `.gitlab-ci.yml` file instead of GitHub Actions workflows.

```bash
ansible-creator init execution_env \
  --scm-provider gitlab \
  --ee-config {
    "name": "ee-network",
    "base_image": "registry.redhat.io/ansible-automation-platform-25/ee-minimal-rhel8:latest",
    "collections": [
      {"name": "cisco.ios"},
      {"name": "ansible.netcommon"}
    ],
    "galaxy_servers": [
      {
        "id": "automation_hub",
        "url": "https://console.redhat.com/api/automation-hub/content/published/",
        "auth_url": "https://sso.redhat.com/auth/realms/redhat-external/protocol/openid-connect/token",
        "token_required": true
      },
      {
        "id": "galaxy",
        "url": "https://galaxy.ansible.com/"
      }
    ]
  } \
  my-ee-gitlab

```

--------------------------------

### Configure collections and SCM servers via JSON

Source: https://docs.ansible.com/projects/creator/ee_scaffolding?q=

Define collections, including private Git repositories, and associated SCM servers using an inline JSON configuration.

```json
{
  "collections": [
    {"name": "ansible.posix"},
    {
      "name": "https://${GITHUB_ORG1_TOKEN}@github.com/my-org/my-ns.my-col",
      "type": "git",
      "version": "1.0.0"
    }
  ],
  "scm_servers": [
    {
      "id": "github_org1",
      "hostname": "github.com",
      "token_env_var": "GITHUB_ORG1_TOKEN"
    }
  ]
}

```

--------------------------------

### Display Ansible Execution Environment Project Structure

Source: https://docs.ansible.com/projects/creator/installing

View the directory structure of a generated Ansible execution environment project using the `tree` command. This command helps in understanding the layout of the EE project files.

```bash
$ tree -la /home/user/ansible-projects/ee-project
.
├── .github
│   └── workflows
│       └── ee-build.yml
├── .gitignore
├── README.md
└── execution-environment.yml

```

--------------------------------

### Configure Collections via JSON

Source: https://docs.ansible.com/projects/creator/ee_scaffolding

Define collections, including those from private Git repositories, using a JSON configuration object for `--ee-config`.

```json
{
  "collections": [
    {"name": "ansible.posix"},
    {
      "name": "https://${GITHUB_ORG1_TOKEN}@github.com/my-org/my-ns.my-col",
      "type": "git",
      "version": "1.0.0"
    }
  ],
  "scm_servers": [
    {
      "id": "github_org1",
      "hostname": "github.com",
      "token_env_var": "GITHUB_ORG1_TOKEN"
    }
  ]
}
```

--------------------------------

### Scaffold EE with a specific base image

Source: https://docs.ansible.com/projects/creator/ee_scaffolding?q=

Specify a custom base image for the Execution Environment using the `--ee-base-image` flag.

```bash
ansible-creator init execution_env \
  --ee-base-image registry.redhat.io/ansible-automation-platform-25/ee-minimal-rhel8:latest \
  my-ee-project

```

--------------------------------

### Generated Ansible Playbook Project Structure

Source: https://docs.ansible.com/projects/creator/installing?q=

This command displays the directory structure of a generated Ansible playbook project. It includes configuration files, collections, development environment configurations, and playbook files.

```bash
$ tree -la /home/user/ansible-projects/playbook-project
.
├── ansible.cfg
├── ansible-navigator.yml
├── collections
│   ├── ansible_collections
│   │   └── myorg
│   │   └── myproject
│   │   │   ├── README.md
│   │   │   └── roles
│   │   │   │   └── run
│   │   │   │   │   ├── README.md
│   │   │   │   │   └── tasks
│   │   │   │   │   │   └── main.yml
│   │   ├── requirements.yml
├── .devcontainer
│   ├── devcontainer.json
│   ├── docker
│   │   └── devcontainer.json
│   └── podman
│   │   └── devcontainer.json
├── devfile.yaml
├── .github
│   ├── ansible-code-bot.yml
│   └── workflows
│   │   └── tests.yml
├── inventory
│   ├── group_vars
│   │   ├── all.yml
│   │   └── web_servers.yml
│   ├── hosts.yml
│   └── host_vars
│   │   ├── server1.yml
│   │   ├── server2.yml
│   │   ├── server3.yml
│   │   ├── switch1.yml
│   │   └── switch2.yml
├── linux_playbook.yml
├── network_playbook.yml
├── README.md
├── site.yml
└── .vscode
    └── extensions.json

```

--------------------------------

### Scaffold EE with Collections

Source: https://docs.ansible.com/projects/creator/ee_scaffolding

Add Ansible collections to the EE project using the `--ee-collections` flag. Repeat the flag for multiple collections.

```bash
ansible-creator init execution_env \
  --ee-collections ansible.posix \
  --ee-collections 'cisco.ios:>=1.0.0' \
  my-ee-project
```

--------------------------------

### Add Resource to Existing Ansible Project Command Template

Source: https://docs.ansible.com/projects/creator/installing?q=

Use this command template to add a resource to an existing Ansible project. Replace `<resource-type>` and `<path>` with the appropriate values.

```bash
ansible-creator add resource <resource-type> <path>

```

--------------------------------

### Commit and Push Changes

Source: https://docs.ansible.com/projects/creator/contributing

Stage new files, commit changes with verbose output, and push the branch to your remote fork. This prepares your contributions for a pull request.

```bash
git add your new files
git commit -v
git push origin your-branch-name
```

--------------------------------

### Configure Galaxy Servers via JSON

Source: https://docs.ansible.com/projects/creator/ee_scaffolding

Define multiple Galaxy servers, including their URLs, authentication details, and token requirements, using a JSON configuration object.

```json
{
  "galaxy_servers": [
    {
      "id": "automation_hub",
      "url": "https://console.redhat.com/api/automation-hub/content/published/",
      "auth_url": "https://sso.redhat.com/auth/realms/redhat-external/protocol/openid-connect/token",
      "token_required": true
    },
    {
      "id": "private_hub",
      "url": "https://pah.corp.example.com/api/galaxy/content/published/",
      "token_required": true,
      "validate_certs": false
    },
    {
      "id": "galaxy",
      "url": "https://galaxy.ansible.com/"
    }
  ]
}
```

--------------------------------

### Configure Galaxy servers via JSON

Source: https://docs.ansible.com/projects/creator/ee_scaffolding?q=

Define multiple Galaxy servers, including their URLs, authentication details, and token requirements, using a JSON configuration.

```json
{
  "galaxy_servers": [
    {
      "id": "automation_hub",
      "url": "https://console.redhat.com/api/automation-hub/content/published/",
      "auth_url": "https://sso.redhat.com/auth/realms/redhat-external/protocol/openid-connect/token",
      "token_required": true
    },
    {
      "id": "private_hub",
      "url": "https://pah.corp.example.com/api/galaxy/content/published/",
      "token_required": true,
      "validate_certs": false
    },
    {
      "id": "galaxy",
      "url": "https://galaxy.ansible.com/"
    }
  ]
}

```

--------------------------------

### Generated Ansible Execution Environment Project Structure

Source: https://docs.ansible.com/projects/creator/installing?q=

This command displays the directory structure of a generated Ansible execution environment project. It includes GitHub workflows, a gitignore file, a README, and the main execution environment configuration file.

```bash
$ tree -la /home/user/ansible-projects/ee-project
.
├── .github
│   └── workflows
│   │   └── ee-build.yml
├── .gitignore
├── README.md
└── execution-environment.yml

```

--------------------------------

### Configure Package Manager Path

Source: https://docs.ansible.com/projects/creator/ee_scaffolding

Specify the path to the package manager for the build. For official Red Hat EE base images, this is automatically set to `/usr/bin/microdnf`.

```json
{
  "options": {
    "package_manager_path": "/usr/bin/microdnf"
  }
}
```

--------------------------------

### Scaffold EE with specified collections

Source: https://docs.ansible.com/projects/creator/ee_scaffolding?q=

Add Ansible collections to the Execution Environment using the `--ee-collections` flag. This can be repeated for multiple collections.

```bash
ansible-creator init execution_env \
  --ee-collections ansible.posix \
  --ee-collections 'cisco.ios:>=1.0.0' \
  my-ee-project

```

--------------------------------

### Add an Action Plugin with Ansible Creator

Source: https://docs.ansible.com/projects/creator/installing

Use this command to scaffold a new action plugin within an existing Ansible collection. Specify the plugin type, name, and the path to your collection.

```bash
ansible-creator add plugin action test_plugin /home/user/..path/to/your/existing_collection

```

--------------------------------

### Configure SCM Servers for Tokens

Source: https://docs.ansible.com/projects/creator/ee_scaffolding

Define SCM providers or organizations for handling tokens for private Git-hosted collections. The `token_env_var` specifies the environment variable name for the token.

```json
{
  "scm_servers": [
    {
      "id": "github_org1",
      "hostname": "github.com",
      "token_env_var": "GITHUB_ORG1_TOKEN"
    },
    {
      "id": "internal_gitlab",
      "hostname": "gitlab.corp.com",
      "token_env_var": "INTERNAL_GITLAB_TOKEN"
    }
  ]
}
```

--------------------------------

### Ansible Collection Directory Structure

Source: https://docs.ansible.com/projects/creator/installing

This command displays the comprehensive directory structure generated for a new Ansible collection project. It's useful for understanding the organization of collection files and directories.

```bash
$ tree -lla /home/ansible-dev/collections/ansible_collections/testns/testname
.
├── CHANGELOG.rst
├── changelogs
│   └── config.yaml
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING
├── .devcontainer
│   ├── devcontainer.json
│   ├── docker
│   │   └── devcontainer.json
│   └── podman
│       └── devcontainer.json
├── devfile.yaml
├── docs
│   ├── docsite
│   │   └── links.yml
│   └── .keep
├── extensions
│   ├── eda
│   │   └── rulebooks
│   │       └── rulebook.yml
│   └── molecule
│       ├── integration_hello_world
│       │   └── molecule.yml
│       └── utils
│           ├── playbooks
│           │   ├── converge.yml
│           │   └── noop.yml
│           └── vars
│               └── vars.yml
├── galaxy.yml
├── .github
│   └── workflows
│       ├── release.yml
│       └── test.yml
├── .isort.cfg
├── LICENSE
├── MAINTAINERS
├── meta
│   └── runtime.yml
├── plugins
│   ├── action
│   │   ├── sample_action.py
│   │   └── __init__.py
│   ├── cache
│   │   └── __init__.py
│   ├── lookup
│   │   ├── sample_lookup.py
│   │   └── __init__.py
│   ├── filter
│   │   ├── sample_filter.py
│   │   └── __init__.py
│   ├── inventory
│   │   └── __init__.py
│   ├── modules
│   │   ├── sample_module.py
│   │   ├── sample_action.py
│   │   └── __init__.py
│   ├── module_utils
│   │   └── __init__.py
│   ├── plugin_utils
│   │   └── __init__.py
│   ├── sub_plugins
│   │   └── __init__.py
│   ├── test
│   │   ├── sample_test.py
│   │   └── __init__.py
├── .pre-commit-config.yaml
├── .prettierignore
├── pyproject.toml
├── README.md
├── roles
│   └── run
│       ├── defaults
│       │   └── main.yml
│       ├── files
│       │   └── .keep
│       ├── handlers
│       │   └── main.yaml
│       ├── meta
│       │   └── main.yml
│       ├── README.md
│       ├── tasks
│       │   └── main.yml
│       ├── templates
│       │   └── .keep
│       ├── tests
│       │   └── inventory
│       ├── vars
│       │   └── main.yml
├── tests
│   ├── .gitignore
│   ├── integration
│   │   ├── __init__.py
│   │   ├── targets
│   │   │   └── hello_world
│   │   │       └── tasks
│   │   │           └── main.yml
│   │   └── test_integration.py
│   └── unit
│       └── .keep
└── .vscode
    └── extensions.json

```

--------------------------------

### Add Resource to Existing Ansible Project

Source: https://docs.ansible.com/projects/creator/installing

Use the `ansible-creator add resource` command to add a resource type to an existing Ansible project. Specify the resource type and the project path.

```bash
ansible-creator add resource <resource-type> <path>

```

```bash
ansible-creator add resource devcontainer /home/user/..path/to/your/existing_project

```

--------------------------------

### Collection URL with Token Placeholder

Source: https://docs.ansible.com/projects/creator/ee_scaffolding

Embed a token variable as a `${...}` placeholder in a collection URL. The placeholder name must match the `token_env_var` from the SCM server configuration.

```json
{
  "collections": [
    {
      "name": "https://${GITHUB_ORG1_TOKEN}@github.com/org1/my-collection",
      "type": "git"
    }
  ],
  "scm_servers": [
    {
      "id": "github_org1",
      "hostname": "github.com",
      "token_env_var": "GITHUB_ORG1_TOKEN"
    }
  ]
}
```

--------------------------------

### Add Plugin to Existing Ansible Collection

Source: https://docs.ansible.com/projects/creator/installing

Use the `ansible-creator add plugin` command to add a plugin to an existing Ansible collection. Specify the plugin type, plugin name, and the collection path.

```bash
ansible-creator add plugin <plugin-type> <plugin-name> <collection-path>

```

--------------------------------

### Configure Private Ansible Galaxy Server

Source: https://docs.ansible.com/projects/creator/ee_scaffolding

Define access to a private Ansible Galaxy server. The `token_required` flag indicates if a token is needed for authentication.

```yaml
galaxy_server:
  galaxy:
    url: https://galaxy.ansible.com/
```

--------------------------------

### Override Execution Environment File Name

Source: https://docs.ansible.com/projects/creator/ee_scaffolding

Specify a custom file name for the execution environment definition. The default is `execution-environment.yml`.

```json
{
  "ee_file_name": "my-ee-definition.yml"
}
```

--------------------------------

### Ansible Galaxy Server Token Secret Naming Convention

Source: https://docs.ansible.com/projects/creator/ee_scaffolding

This is the naming convention for Ansible Galaxy server tokens required as secrets for CI/CD workflows. The `<ID>` must match the `[galaxy_server.<id>]` section in `ansible.cfg`.

```bash
ANSIBLE_GALAXY_SERVER_<ID>_TOKEN

```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.