Added wiki
+69
@@ -0,0 +1,69 @@
|
||||
# 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](https://deno.land/#installation).
|
||||
|
||||
Once Deno is installed, you can install the PolyMPR CLI globally by running:
|
||||
|
||||
```bash
|
||||
deno task compile
|
||||
```
|
||||
|
||||
Verify the installation by running:
|
||||
|
||||
```bash
|
||||
pmpr --version
|
||||
```
|
||||
|
||||
## CLI Commands Overview 🖥️
|
||||
|
||||
### General commands 🖥️
|
||||
|
||||
#### `pmpr help`
|
||||
|
||||
**Syntax**
|
||||
```bash
|
||||
pmpr help
|
||||
```
|
||||
Get all available commands, run by default when `pmpr` is runned without any command.
|
||||
|
||||
### Module commands 🧩
|
||||
|
||||
#### `pmpr module list`
|
||||
|
||||
**Syntax**
|
||||
```bash
|
||||
pmpr module list
|
||||
```
|
||||
List all modules. Pipe this command through `grep` to check if a module is defined.
|
||||
|
||||
#### `pmpr module create`
|
||||
|
||||
**Syntax**
|
||||
```bash
|
||||
pmpr module create <module-name-kebab-case>
|
||||
```
|
||||
Create a new module with the name given as argument. Please refer to the [modules page](./modules) for further information about module creation.
|
||||
|
||||
## Troubleshooting 🛠️
|
||||
|
||||
If you encounter issues while using the CLI, try the following:
|
||||
|
||||
1. **Check the Logs**: Look for error messages in the terminal output.
|
||||
2. **Update the CLI**: Ensure you’re using the latest version of the PolyMPR CLI.
|
||||
```bash
|
||||
deno task compile
|
||||
```
|
||||
3. **Consult the Documentation**: Refer to the [CLI documentation](/cli) for detailed usage instructions.
|
||||
4. **Ask the Community**: Reach out to the [GitHub Discussions](https://github.com/fedyna-k/PolyMPR/discussions) for help.
|
||||
|
||||
## Next Steps 🚀
|
||||
|
||||
Now that you’re familiar with the PolyMPR CLI, here are some resources to help you get started:
|
||||
- **[Tutorials](./tutorials)**: Step-by-step guides for common tasks.
|
||||
- **[FAQs](./faqs)**: Find answers to common questions.
|
||||
|
||||
Thank you for using the PolyMPR CLI! If you have any questions or need further assistance, feel free to reach out to the community. Happy coding! 💻✨
|
||||
+1
-1
@@ -34,7 +34,7 @@ Before you start contributing, you'll need to set up your development environmen
|
||||
4. **Set Up Docker (Optional)**:
|
||||
- If you plan to use Docker, ensure it’s installed and running. Use the provided `docker-compose.yml` file to build and run the application:
|
||||
```bash
|
||||
docker-compose up --build
|
||||
docker compose up --build
|
||||
```
|
||||
|
||||
### 2. **Find an Issue or Suggest a New Feature**
|
||||
|
||||
+11
@@ -0,0 +1,11 @@
|
||||
# Tutorials 🎓
|
||||
|
||||
Work in progress...
|
||||
|
||||
## Explore the Wiki 📚
|
||||
|
||||
- **[Installation Guide](./installation)**: Learn how to set up PolyMPR on your local machine to start development. 🖥️
|
||||
- **[Modules](./modules)**: Learn how to create modules in PolyMPR. 🧩
|
||||
- **[CLI Documentation](./cli)**: Dive into the technical details of PolyMPR's CLI. 📄
|
||||
- **[FAQs](./faqs)**: Find answers to common questions about PolyMPR. ❓
|
||||
- **[Release Notes](./releases)**: Stay up-to-date with the latest features and improvements. 📰
|
||||
Reference in New Issue
Block a user