all modules custom or core use the same installer and have consistent behavior now.

This commit is contained in:
Brian Madison
2025-12-07 17:17:50 -06:00
parent baaa984a90
commit 6430173738
44 changed files with 393 additions and 253 deletions

View File

@@ -64,7 +64,7 @@ A custom module follows this structure:
my-module/
├── _module-installer/
│ ├── installer.js # optional, when it exists it will run with module installation
│ └── install-config.yaml # Module installation configuration with custom question and answer capture
├── module.yaml # Module installation configuration with custom question and answer capture
├── docs/ # Module documentation
├── agents/ # Module-specific agents
├── workflows/ # Module-specific workflows
@@ -77,7 +77,7 @@ my-module/
#### Module Configuration
The `_module-installer/install-config.yaml` file defines how your module is installed:
The `module.yaml` file defines how your module is installed:
```yaml
# Module metadata
@@ -99,12 +99,6 @@ my_setting:
See `/example-custom-module` for a complete example:
```bash
# The example is ready to use - just rename the _module-installer/install-config file:
mv example-custom-module/mwm/_module-installer/install-config.bak \
example-custom-module/mwm/_module-installer/install-config.yaml
```
## Installation Process
### Step 1: Running the Installer
@@ -129,7 +123,7 @@ If you select "Enter a directory path", the installer will prompt for the locati
The installer will:
- Scan the directory and all subdirectories for the presence of a `custom.yaml` file (standalone content such as agents and workflows)
- Scan for `_module-installer/install-config.yaml` files (modules)
- Scan for `module.yaml` files (modules)
- Display an indication of how many installable folders it has found. Note that a project with stand along agents and workflows all under a single folder like the example will just list the count as 1 for that directory.
### Step 3: Selecting Content
@@ -230,7 +224,7 @@ Custom content can be distributed:
### No Custom Content Found
- Ensure your `custom.yaml` or `install-config.yaml` files are properly named
- Ensure your `custom.yaml` or `module.yaml` files are properly named
- Check file permissions
- Verify the directory path is correct

View File

@@ -59,6 +59,7 @@ project-root/
### Key Exclusions
- `_module-installer/` directories are never copied to destination
- module.yaml
- `localskip="true"` agents are filtered out
- Source `config.yaml` templates are replaced with generated configs
@@ -92,8 +93,8 @@ Creative Innovation Studio for design workflows
```
src/modules/{module}/
├── _module-installer/ # Not copied to destination
│ ├── installer.js # Post-install logic
│ └── install-config.yaml
│ ├── installer.js # Post-install logic
├── module.yaml
├── agents/
├── tasks/
├── templates/
@@ -107,7 +108,7 @@ src/modules/{module}/
### Collection Process
Modules define prompts in `install-config.yaml`:
Modules define prompts in `module.yaml`:
```yaml
project_name:
@@ -218,12 +219,12 @@ Platform-specific content without source modification:
src/modules/mymod/
├── _module-installer/
│ ├── installer.js
│ └── install-config.yaml
├── module.yaml
├── agents/
└── tasks/
```
2. **Configuration** (`install-config.yaml`)
2. **Configuration** (`module.yaml`)
```yaml
code: mymod