This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
CLI Documentation 📄
The PolyMPR CLI is a powerful command-line tool designed to simplify the
development of PolyMPR. This page provides an overview of the CLI commands and
their usage. 🛠️
Installation ⚙️
To use the PolyMPR CLI, ensure you have Deno installed. If not, follow the
Deno installation guide.
Once Deno is installed, you can install the PolyMPR CLI globally by running:
deno task compile
Verify the installation by running:
pmpr help
CLI Commands Overview 🖥️
General commands 🖥️
pmpr help
Syntax
pmpr help
Get all available commands, run by default when pmpr is runned without any
command.
Module commands 🧩
pmpr module list
Syntax
pmpr module list
List all modules. Pipe this command through grep to check if a module is
defined.
pmpr module create
Syntax
pmpr module create <module-name-kebab-case>
Create a new module with the name given as argument. Please refer to the
modules page for further information about module creation.
Troubleshooting 🛠️
If you encounter issues while using the CLI, try the following:
Check the Logs: Look for error messages in the terminal output.
Update the CLI: Ensure you’re using the latest version of the PolyMPR
CLI.
deno task compile
Consult the Documentation: Refer to the CLI documentation for
detailed usage instructions.