> ## Documentation Index
> Fetch the complete documentation index at: https://docs.myrax.app/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI

> Every myrax command

The binary is the panel, the installer's target and the CLI in one. All
commands run as root on the server.

## Core

| Command           | What it does                               |
| ----------------- | ------------------------------------------ |
| `myrax serve`     | run the panel (what the service unit runs) |
| `myrax configure` | change bind, port, panel path, credentials |
| `myrax update`    | self-update from the latest GitHub release |
| `myrax version`   | print version                              |
| `myrax uninstall` | remove binary, service, config and data    |
| `myrax help`      | usage                                      |

### serve flags

| Flag       | Meaning             |
| ---------- | ------------------- |
| `--host`   | bind address        |
| `--port`   | listen port         |
| `--config` | path to config.toml |

### configure flags

| Flag               | Meaning                          |
| ------------------ | -------------------------------- |
| `--host`, `--port` | bind address and port            |
| `--panel-path`     | URL prefix for the panel         |
| `--username`       | admin username                   |
| `--password-stdin` | read the new password from stdin |
| `--config`         | path to config.toml              |

## Add-ons

The plugin system is off by default:

```sh theme={null}
myrax add-ons status
myrax add-ons enable
myrax add-ons disable
```

## Plugins

| Command                                     | What it does                                                        |
| ------------------------------------------- | ------------------------------------------------------------------- |
| `myrax plugin store`                        | show the built-in catalog                                           |
| `myrax plugin list`                         | list installed plugins (interactive enable/disable)                 |
| `myrax plugin install <name\|url\|path>`    | install from the store by name, from a git URL or a local directory |
| `myrax plugin update <id>`                  | re-install from the plugin's source                                 |
| `myrax plugin remove`                       | pick and remove a plugin                                            |
| `myrax plugin enable <id>` / `disable <id>` | toggle without removing                                             |
| `myrax plugin logs <id>`                    | tail the runtime log                                                |
| `myrax plugin restart <id>`                 | restart the runtime process                                         |

```sh theme={null}
myrax plugin install terminal                          # from the store
myrax plugin install https://github.com/you/my-plugin  # from GitHub
myrax plugin install /opt/dev/my-plugin                # from a local path
```

`myrax plugin-runtime` is internal — it hosts built-in runtimes (the Terminal
pty) and is only meant to be referenced from plugin manifests.
