Create a module

To create a default module skeleton and testing templates, use the pdk new module command.

Before you begin:

Ensure that you've installed the PDK package.

If you are running PDK behind a proxy, be sure you've added the correct environment variables. See instructions for running PDK behind a proxy for details.

  1. From the command line, run the new module command, specifying the name of the module: pdk new module <MODULE_NAME>

    Optionally, to omit the interview questions and create the module with default metadata values, add the skip-interview flag: pdk new module <MODULE_NAME> --skip-interview

  2. Respond to the dialog questions. Each question indicates the default value that it will use if you press Enter.
    1. Forge username: Enter your Forge username, if you have an account.
    2. Version: Enter the semantic version of your module, such as 0.1.0.
    3. Author: Enter the name of the module author (you or someone else responsible for the module's content).
    4. License: If you want to specify a license other than Apache-2.0, specify that here, such as MIT, or proprietary.
    5. Operating System Support: Select which operating systems your module supports, choosing from the dialog menu.
    6. Description: Enter a one-sentence summary that helps other users understand what your module does.
    7. Source code repository: Enter the URL to your module's source code repository.
    8. Where others can learn more: If you have a website where users can learn more about your module, enter the URL.
    9. Where others can report issues: If you have a public bug tracker for your module, enter the URL.
  3. At the prompt, confirm or cancel module creation.