> 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/bot-manager/bot-info.md).

# Get Bot Info

```bash
# Manage bots in the mini-app
portex bot <app-name>
```

## Description

The `portex bot` command is used to manage Telegram bots that are bound to mini-apps. This command retrieves and displays information about the Telegram bot associated with the specified mini-app. The `portex bot` command is only applicable to mini-apps hosted on the Telegram platform.

## Parameters

| Parameter    | Description                                                                                                                                    | Required |
| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| `<app-name>` | The name of the application. This parameter is required and should correspond to the name of the mini-app that you want to manage the bot for. | Yes      |

## Example

```bash
# Display information about the Telegram bot bound to the "MyApp" application
portex bot MyApp
```

## Success and Failure Messages

* **Success**: After successfully retrieving the bot's information, the system will display the following table:

  ```
  +----------------------+------------------------------------------------------------------+-----------------------------------------+
  | name                 | description                                                    | short_description                      |
  +----------------------+------------------------------------------------------------------+-----------------------------------------+
  | MyBot                | This is a bot for MyApp                                         | A short description of MyBot            |
  +----------------------+------------------------------------------------------------------+-----------------------------------------+
  ```
* **Failure**: If the application is not bound to a Telegram bot, an error message will be shown:

  ```
  Telegram Application is not bound to a Telegram bot. Please use 'portex bot register MyApp <bot_token>' to bind a Telegram bot before setting menu.
  ```

  Additionally, if the platform is not Telegram, the following error message will be displayed:

  ```
  Only Telegram Platform Application supports.
  ```

## Notes

* **Platform Support**: The `portex bot` command is only supported for mini-apps that are hosted on the Telegram platform.
* **Bot Registration**: If the mini-app is not bound to a Telegram bot, you can register the bot using the `portex bot register` command, providing the bot token as an argument.

## Additional Information

* **Register a Bot**: If you need to register a Telegram bot for your mini-app, you can use the following command:

  ```bash
  portex bot register <app-name> <bot-token>
  ```
* **Bot Management**: Once the bot is registered, you can manage the bot's settings, including menus and other configurations, using additional bot commands.


---

# 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://portex-app.gitbook.io/docs/cli/bot-manager/bot-info.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.
