> For the complete documentation index, see [llms.txt](https://mandarineframework.gitbook.io/mandarine-ts/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://mandarineframework.gitbook.io/mandarine-ts/v1.0.1/mandarine-cli/cli.md).

# CLI Reference

## Main

The Mandarine CLI is a command interface tool that you use to create Mandarine-powered applications as well as Mandarine-powered modules.

In order to install Mandarine's CLI, you need to have installed Deno in your computer. Then, run from your terminal the following command:

```bash
deno install --allow-read --allow-write --allow-run -n mandarine https://deno.land/x/mandarinets/cli.ts
```

## Usage

```bash
mandarine [OPTIONS] [SUBCOMMAND]
```

**Options:**

| Option        | Description                                      |
| ------------- | ------------------------------------------------ |
| -h, --help    | Shows the help information of Mandarine's CLI.   |
| -v, --version | Shows the version information of Mandarine's CLI |

**Subcommand**:

| Subcommand                                                                                          | Alias | Description                                                                                                         |
| --------------------------------------------------------------------------------------------------- | ----- | ------------------------------------------------------------------------------------------------------------------- |
| [new](https://mandarineframework.gitbook.io/mandarine-ts/mandarine-cli/cli/mandarine-new)           | n     | Creates a Mandarine-powered application (following Mandarine's project structure) in the current working directory. |
| [generate](https://mandarineframework.gitbook.io/mandarine-ts/mandarine-cli/cli/mandarine-generate) | g     | Generates a Mandarine-powered module.                                                                               |
| [run](https://mandarineframework.gitbook.io/mandarine-ts/mandarine-cli/cli/mandarine-run)           | r     | Compiles & Run the mandarine application located in the current working directory.                                  |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://mandarineframework.gitbook.io/mandarine-ts/v1.0.1/mandarine-cli/cli.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
