---
metadata:
  - name: generator
    content: Diplodoc Platform v5.54.2
  - property: og:type
    content: article
  - property: article:section
    content: Plugin platform
  - property: og:title
    content: CLI
  - property: article:tag
    content: Technical instructions
alternate:
  - https://yandex.ru/support/tracker/en/plugins/tools/cli.md
  - https://yandex.ru/support/tracker/ru/plugins/tools/cli.md
  - href: en/plugins/tools/cli.md
    type: text/markdown
    title: Markdown version
  - href: ../../llms.txt
    type: text/markdown
    title: llms.txt
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/support/tracker/en/llms.txt


# CLI

CLI is a console utility packaged as an NPM package that supports the entire plugin lifecycle: creating, debugging, testing, and publishing.

## Available commands {#commands}

| **Command**  | **Description**                                                                  |
|-------------------|-------------------------------------------------------------------------------|
| create            | Create a plugin from a template                                                     |
| build             | Build a plugin                                                                |
| login             | Log in to account (set a token in the CLI)                                      |
| logout            | Log out of account                                                             |
| whoami            | View the current username                                          |
| submit            | Publish a plugin      |
| list              | View the list of your registered plugins                           |
| debug             | Debug a plugin                                                               |
| lint              | Check a plugin                                                              |
| up                | Migrate a plugin to a new version of tools                                 |
| feedback          | Contact support                                                          |
| help              | Display a list of all plugin commands                                            |


## Installation {#install}

```bash
npm install -g @weavix/cli 
```

## Local development {#debug}

1. First, enable the plugin debugging mode in the Tracker interface.

    ```
    Settings - Experiments - Plugin debugging
    ```

    When you enable debugging, the browser may request permission for the site to access the local network. Grant access: without it, debugging will not work, because the config and plugins are loaded from `localhost`.

2. Then run the debug mode in the plugin folder:

    ```bash
    weavix debug
    ```

3. Open the integration point used in the plugin in the Tracker interface.

4. Make changes to the plugin interface code — they are applied to the interface immediately.

## Publishing a plugin {#publish}

Publishing is performed in the following order:

1. Get a token for the CLI:

    ```bash
    weavix login
    ```

2. Before publishing, make sure that the project contains the required files for the catalog:

    - `public/logo.svg`
    - `marketplace/header-image.jpg`
    - `marketplace/index.md`

3. Run the full publishing process:

    ```bash
    weavix submit
    ```

    This command will register the plugin if necessary, upload the distribution, and submit the version for moderation.

4. After submitting for moderation, check the publication status:

    ```bash
    weavix list
    ```