| name | init-config |
| description | Generate an SDLC runner config for the current project. Use when user says 'generate config', 'set up SDLC runner', 'configure runner', 'init config', 'how do I set up the runner', or asks about sdlc-config.json. Creates a ready-to-use sdlc-config.json from the template with project-specific paths. Prerequisite for $nmg-sdlc:run-loop. |
Init Config
Read ../../references/codex-tooling.md when the workflow starts โ it maps legacy tool wording to Codex-native file inspection, shell, editing, web, interactive-gate, and subagent behavior.
Read ../../references/interactive-gates.md when the workflow reaches any manual-mode user decision, menu, review gate, or clarification prompt โ Codex asks through request_user_input in Plan Mode, then finalizes a <proposed_plan> before execution.
Read ../../references/contribution-gate.md when runner config setup reaches managed project artifact creation โ the shared contract defines the GitHub Actions contribution-gate workflow, managed marker/version, safe update rules, and stable status output.
Read ../../references/issue-form.md when runner config setup reaches managed issue-form installation โ the shared contract defines the GitHub Issue Form path, canonical template source, overwrite rule, preservation rule, and stable status output.
Generate a ready-to-use sdlc-config.json for the SDLC runner by substituting the current project directory into the config template.
Steps
-
Resolve the project root โ find the root of the Codex project by locating the nearest ancestor directory containing a .codex/ folder:
git rev-parse --show-toplevel
Then verify it's a Codex project:
test -d "$(git rev-parse --show-toplevel)/.codex"
If .codex/ does not exist at the repo root, stop and tell the user: this must be run from within a Codex project (a directory with .codex/ at its root).
Use this resolved project root for all subsequent steps โ do NOT use pwd directly, as it may differ from the project root.
-
Find and read the template from the local Codex plugin checkout. Use file discovery to locate:
~/.codex/plugins/**/nmg-sdlc/**/scripts/sdlc-config.example.json
Prefer a match where skills/run-loop/SKILL.md exists under the same plugin root. If multiple versioned cache entries match, use the newest version directory. If no installed copy is found, fall back to this source checkout when it contains scripts/sdlc-config.example.json.
-
Derive the project name from the project root's basename:
basename "$(git rev-parse --show-toplevel)"
-
Resolve the plugin root โ take the parent directory of the scripts/ directory that contains the template selected in Step 2. Verify this root contains both .codex-plugin/plugin.json and skills/.
-
Substitute values โ replace the placeholder fields in the template:
"projectPath": "/path/to/your/project" โ the resolved project root from Step 1"pluginRoot": "/path/to/nmg-sdlc" โ the resolved plugin root, expanded to the full absolute path- Leave
"pluginsPath" empty unless the local checkout uses the legacy plugins/nmg-sdlc monorepo layout
-
Write the config file โ save the fully substituted config JSON to sdlc-config.json in the project root (resolved in Step 1). Use Codex editing.
-
Add to .gitignore โ ensure sdlc-config.json and .codex/sdlc-state.json are listed in the project's .gitignore:
- Read the
.gitignore file in the project root. If it does not exist, create it.
- For each of
sdlc-config.json and .codex/sdlc-state.json: if NOT already present, add it under an # SDLC runner config comment.
- If both are already listed, skip this step.
-
Install the managed contribution gate โ apply ../../references/contribution-gate.md in the resolved project root:
- Create
.github/workflows/ when needed.
- If
.github/workflows/nmg-sdlc-contribution-gate.yml is absent, write the managed workflow template.
- If the file is already nmg-sdlc-managed and current, leave it unchanged.
- If the file is nmg-sdlc-managed and outdated, update only that workflow from the shared contract.
- If the file exists without the managed marker, leave it untouched and record a path-collision gap.
- Preserve every unrelated workflow under
.github/workflows/ byte-for-byte.
-
Install the managed issue form โ apply ../../references/issue-form.md in the resolved project root:
- Read the canonical
.github/ISSUE_TEMPLATE/nmg-sdlc-ready-issue.yml template from the resolved plugin root.
- Create
.github/ISSUE_TEMPLATE/ when needed.
- If
.github/ISSUE_TEMPLATE/nmg-sdlc-ready-issue.yml is absent, write the managed form template.
- If the file already matches the canonical template, leave it unchanged.
- If the file exists and differs from the canonical template, replace it and report
overwritten.
- Preserve every unrelated issue template under
.github/ISSUE_TEMPLATE/ byte-for-byte.
-
Confirm and suggest next step โ tell the user the config has been written and is git-ignored, include the stable Contribution Gate status block from ../../references/contribution-gate.md and the stable Issue Form status block from ../../references/issue-form.md, then suggest:
Run the SDLC runner:
$nmg-sdlc:run-loop
Or run directly:
node scripts/sdlc-runner.mjs --config sdlc-config.json
Examples
Example 1: First-time setup
User says: "Set up the SDLC runner for this project"
Actions: Resolves project root, reads template, substitutes paths, writes sdlc-config.json, adds to .gitignore, installs the managed contribution gate, and installs the managed issue form
Result: Config file, contribution-gate workflow, and SDLC-ready issue form ready at project root; user told how to run the runner
Example 2: Project without .codex/
User says: "Generate a runner config"
Actions: Resolves project root, checks for .codex/ directory
Result: Stops with error โ "This must be run from within a Codex project"
Integration with SDLC Workflow
This skill is a utility for setting up the SDLC runner. It generates the configuration file that sdlc-runner.mjs reads to orchestrate the development cycle. It is not part of the SDLC cycle itself but supports the automation layer that drives it.
