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

# Check Mini-app

```bash
# List applications
portex ls [-i <application-id>] [-n <application-name>] [-p <platform-name>]
```

## Description

The `portex ls` command is used to fetch and display a list of applications. You can filter the list based on the application ID, application name, or platform name. If no flags are provided, it will return all applications.

## Parameters

| Type     | Argument/Flag         | Description                                               | Required |
| -------- | --------------------- | --------------------------------------------------------- | -------- |
| **Flag** | `-i, --appId`         | **Optional**: The application ID to filter the list by.   | No       |
| **Flag** | `-n, --appName`       | **Optional**: The application name to filter the list by. | No       |
| **Flag** | `-p, --platform_name` | **Optional**: The platform name to filter the list by.    | No       |
| **Flag** | `-h, --help`          | **Optional**: Display help information for the command.   | No       |

## Example

```bash
# List all applications
portex ls

# List applications by application ID
portex ls -i app123

# List applications by application name
portex ls -n MyApp

# List applications by platform name
portex ls -p web
```

## Success and Failure Messages

* **Success**: When the list of applications is successfully fetched, the applications will be displayed in a tabular format, including details such as application ID, name, platform, description, and version.

  **Sample Output**:

| appliaction\_id             | app\_name | platform\_name | description | version |    |    |    |
| --------------------------- | --------- | -------------- | ----------- | ------- | -- | -- | -- |
| last                        | dev       | test           | prod        |         |    |    |    |
| 2vHJYRLPpqL8jEq5J79pse2uPV0 | gameva    | Web            | -           | 17      | 12 | 17 | 17 |

* **Failure**: If no applications are found based on the filters or if an error occurs during the fetching process, you will see the following messages:
  * `No application found, please create an application first`
  * `Get application list error`

## Notes

* **Filtering**: You can filter the list of applications by providing one or more flags:
  * `-i` for the application ID
  * `-n` for the application name
  * `-p` for the platform name (e.g., `web`, `telegram`)
* **Tabular Output**: The applications are displayed in a table with the following columns:
  * **appliaction\_id**: The unique ID of the application.
  * **app\_name**: The name of the application.
  * **platform\_name**: The platform on which the application is deployed (e.g., `web`).
  * **description**: A brief description of the application.
  * **version**: The application version, including its last, development, test, and production versions.


---

# 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, and the optional `goal` query parameter:

```
GET https://portex-app.gitbook.io/docs/cli/ls.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.