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

# CLI axottle

> CLI axottle command directory: status, diagnosis, logs, administrator password reset.

`axottle` is a single binary: it runs a panel (`axottle serve`), it serves as a CLI for control and diagnostics. Once installed, the command is available from `PATH` on the panel server.

Running **without arguments** opens an interactive terminal interface (TUI) - the same as `axottle tui`.

> [!NOTE]
>
> For whom: Administrator, SRE. Required rights: Normal commands - any user with access to the panel API; `axottle admin reset-password` - root only, sudo or owner of the panel installation directory.

## Common flags

Most commands (status, version, doctor) accept a common set of flags:

\| Flag | What does | do?
\|---|---|
\| `--api <url>` | Basic Panel URL (`http://localhost:8080` by default; can be specified via `AXOTTLE_API_URL`) |
\| `--token <токен>` | Bearer-token for API calls (can be specified via `AXOTTLE_API_TOKEN`) |
\| `--json` | Output JSON |
\| `--table` | Table output |
\| `--plain` | Simple text output |
\| `--verbose` | Detailed conclusion |
\| `--debug` | Debugging Output |
\| `--yes` | Miss confirmations (for dangerous commands) |

Output language: `AXOTTLE_LANG=ru` compulsorily includes Russian; otherwise, the language is defined from `LANG`.

## Teams.

### `axottle tui`

Interactive terminal interface (runs and just command `axottle` without arguments), it can check the status of the panel, open the Doctor, see the logs, reset the administrator password and find out the version.

The Doctor section provides routine diagnostics, safe recovery of services and collection of support bundle for the selected period. Results are scrolled by arrows, mouse wheel, `Page Up` / `Page Down`, `Home` / `End`.

### `axottle serve`

Launches the panel: downloads the configuration, connects to PostgreSQL, applies database migrations, raises the API and the built-in web interface; correctly terminates by SIGINT / SIGTERM.

> [!NOTE]
>
> The production panel is launched by the service `axottle.service` manually `axottle serve` You don't need to run the battle server (the second process won't be able to take the same port). `systemctl`.

### `axottle status`

Interrogates `GET /api/v1/system/status` and prints the status of the panel.

```bash theme={null}
axottle status
```

```text theme={null}
Status:      running
Version:     <версия>
DB:          connected
Setup done:  true
Uptime:      3h12m
```

Ends with non-zero code if the status is different from `running`, convenient for monitoring scripts.

### `axottle version` (`v`)

Prints a version of the CLI build and - by live request to the API - a version of the working panel.

### `axottle doctor`

Checks the panel server and shows the status of services, database, disk, network, DNS, TLS and connected components.

```bash theme={null}
axottle doctor
axottle doctor --json
```

Each test receives the status of `OK`, `Warning`, `Failed`, `Skipped` or `Unknown`. Next, it indicates what is detected and what action is recommended. The problem found does not interrupt the other checks: Doctor tries to show everything he has learned about the server. The latest result is stored and available from the TUI through **View last diagnosis**.

The command should be run on the panel server. If the database is not available, the rest of the checks will still be performed, and the state of the database will be shown as a problem. To check the data from PostgreSQL Doctor uses the configuration of the installed panel.

> [!TIP]
>
> Through TUI (`sudo axottle` → **Doctor**), you can select the log period, collect the support bundle, view its composition, save the file locally or send it to support. Passwords, tokens and keys are masked before saving. Detailed instructions are on the [Service page and Axottle Doctor](https://docs.axottle.com/en/operations/maintenance.md).

### `axottle logs <component>`

Components: `backend` (default; `frontend` is synonymous with backend), `worker`, `scheduler`, `nginx`.

\| Flag | What does | do?
\|---|---|
\| `--tail N`, `-n N` | Last N rows (default 100) |
\| `--follow`, `-f` | Follow the real-time log |
\| `--since <длительность>` | Logs for a period, for example `1h`, `30m` |
\| `--level` | Not yet supported (team will display warning) |

The team selects the source itself in order: Docker Compose logs → journald (`journalctl -u axottle…`) → log files in standard directories.

```bash theme={null}
axottle logs backend --tail 200
axottle logs backend -f
```

### `axottle admin reset-password` (`reset`)

Offline password reset – works directly with the database, without API and without a valid session.

\| Flag | What does | do?
\|---|---|
\| `--password <пароль>` | Set a given password. Without a flag, a random password of 16 characters is generated |
\| `--yes` | Miss confirmation |

Rights: the command is executed by **only with privileges on the server of the** panel - root, sudo or the owner of the installation directory.

Behavior: the team shows the list of administrators (at several - interactive selection), requests confirmation (skipped by the `--yes` flag), saves a new password hash in the database, **records the event in the audit journal** and prints a new password to the terminal.

```bash theme={null}
sudo axottle admin reset-password
```

```text theme={null}
Admins:
  1) <username> (admin)
Reset password for <username>? [y/N] y
New password: <сгенерированный-пароль>
```

> [!WARNING]
>
> **Dangerous team.** The old administrator password immediately ceases to work. The password is printed in plain form - run in a secure terminal and do not leave an output in the session history / logs.
>
> **Rollback:** No direct recoil - the previous hash is not restored. To regain control or change a compromised password, run the command again with `--password <известный-пароль>` or change the password through the panel. The reset fact is visible in the audit log of the panel.

### `axottle help` (`-h`, `--help`)

Printing a team certificate.

## Verification

> [!TIP]
>
> CLI is configured correctly if `axottle status` shows `running` and `axottle doctor` completes all checks without `Failed` status.

```bash theme={null}
axottle status && axottle doctor
```

## Rollback

Rollback summary for teams that change state:

| command | What changes | How to roll back |
| - | - | - |
| `admin reset-password` | Replaces the | Administrator Password Re-start with `--password` or change the password in the panel; the previous password is not restored by |

The commands `status`, `version`, `doctor`, `logs` are read only, no rollback is required.

## Typical errors

> [accordion] CLI cannot reach the panel API
>
> By default, CLI runs on `http://localhost:8080`. If the panel listens to another address or port, specify `--api <url>` or export `AXOTTLE_API_URL`. Check that the service is running: `systemctl status axottle`.

> [accordion] Doctor or Admin Reset Password does not find the database.
>
> These commands connect to PostgreSQL directly. Export `AXOTTLE_DB_URL` to the environment or create `.env` in one of the directories: `./.env`, `/opt/axottle/.env`, `/var/lib/axottle/.env`, `~/.axottle/.env`.

> [accordion] admin reset-password: not enough privileges
>
> The command requires root, sudo, or ownership of the panel installation directory. Run through `sudo axottle admin reset-password`.

> [accordion] logs: component logs not found
>
> The team goes through the sources (Docker Compose → journald → files). If none of them work, check how the component is deployed, and look at `journalctl -u axottle` directly.

## Related pages

> [card] [Panel configuration](https://docs.axottle.com/en/reference/configuration.md)
>
> Env-file, service restart, order of changes.

> [card] [Error codes](https://docs.axottle.com/en/reference/error-codes.md)
>
> HTTP statuses of the API and operator actions.

> [card] [Panel updates](https://docs.axottle.com/en/operations/updates.md)
>
> Update Now button and update script.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.