Skip to content

Get started#

Start new modules from the PSModule template repository: Template-PSModule.

Quickstart#

  1. Create a new repository from the template.
  2. Configure the repository — GitHub Pages, PSGALLERY_API_KEY, and the caller workflow.
  3. Replace placeholder metadata and remove scaffold sample files.
  4. Add your first public command and tests.
  5. Validate .github/PSModule.yml defaults for your module.
  6. Open a draft pull request, then release from its resulting important default-branch push.

If the module needs several interdependent commands before it is usable at all, see Module bootstrap instead of shipping them as one command per step.

Expected outcomes#

  • The repository follows the expected structure.
  • The module can be built and tested in CI.
  • The release strategy is ready when functionality is implemented.

In this section#

Page Description
Repository setup GitHub Pages, PSGALLERY_API_KEY, permissions, and the caller workflow.
Your first release The pull request flow, version labels, and the resulting default-branch release.
Module bootstrap Getting a brand-new module to its first release with an integration branch.

For framework-level practices, refer to MSX Ways of Working.