Skip to content

RAGFlow is an agent-native database: a Retrieval-Augmented Generation (RAG) engine that grew into context infrastructure.

docs: Update the CLI documentation to reflect the actual implementation. (#20821)

YanZhang263672cb7012
diff --git a/docs/administrator/admin/ragflow_cli.md b/docs/administrator/admin/ragflow_cli.md
index 47e2062273..d6f81e560e 100644
--- a/docs/administrator/admin/ragflow_cli.md
+++ b/docs/administrator/admin/ragflow_cli.md
@@ -77,7 +77,7 @@ RAGFLOW_DEV_MODE=true ./bin/ragflow_server --admin --init-superuser
If this creates the first superuser, its email is `[email protected]` and its initial password is `admin`. Change that password immediately after the first login. The option does not reset an existing superuser's password.
-Then start the CLI in Admin mode. It connects to `127.0.0.1:9381` by default:
+Then start the CLI in Admin mode. If `--host` is omitted, it connects to `127.0.0.1:9381` by default:
```bash
ragflow-cli --admin
@@ -85,6 +85,8 @@ ragflow-cli --admin
When using a binary built from source, replace `ragflow-cli` with `./bin/ragflow-cli` in the following examples.
+Port `9381` is the default Admin Service port inside the RAGFlow container. When Docker publishes it on a different host port, replace `9381` with the actual published port. Check `ADMIN_SVR_HTTP_PORT` in **docker/.env** or the port mapping shown by `docker ps`. For example, a mapping of `0.0.0.0:49381->9381/tcp` means that the CLI must connect to port `49381`.
+
To connect to another Admin Service, pass a `host:port` value:
```bash
@@ -104,11 +106,11 @@ Avoid passing a real password with `--password`: command-line arguments can be v
| Option | Description |
|-------------------------------|-------------------------------------------------------------------------------------------------------|
| `--admin`, `-admin` | Start in Admin mode. |
-| `-h`, `--host <host:port>` | Admin Service address. The default is `127.0.0.1:9381`. |
+| `-h`, `--host <host:port>` | Admin Service address. The default is `127.0.0.1:9381`; use the actual published host port when it differs. |
| `-u`, `--user <email>` | Administrator email address. |
| `-p`, `--password <password>` | Administrator password. Prefer the interactive prompt to avoid exposing it in command-line arguments. |
-| `-k`, `--key <path>` | Key file used by the client. |
-| `-o`, `--output <format>` | Output format: `table`, `plain`, or `json`. |
+| `-k`, `--key <path>` | RSA public key file used to encrypt passwords sent to the Admin Service. |
+| `-o`, `--output <format>` | Output format: `table` (default), `plain`, or `json`. |
| `-v`, `--verbose` | Enable verbose output. |
## Commands
@@ -198,7 +200,7 @@ RAGFlow(admin)> SHOW VERSION;
#### 1.5 SHOW CURRENT
-Shows the current CLI mode, server connection, authentication state, and output format.
+Shows the current CLI mode, configured server address, authentication state, and output format. This command displays locally stored connection information; it does not check whether the Admin Service is reachable. Use `PING;` to check the actual connection.
**Syntax**
@@ -380,6 +382,8 @@ Deletes a user and associated data.
An active user cannot be deleted. Run `ALTER USER ACTIVE '<email>' off;` before `DROP USER`. Otherwise, the Admin Service returns `user is active and can't be deleted. Please deactivate the user first`.
+Administrator accounts cannot be deleted with this command.
+
**Syntax**
```sql
@@ -549,7 +553,7 @@ If the name does not exist in the local configuration, the command returns `api_
### 7. Message queue commands
-The MQ commands operate on the NATS JetStream task stream used by ingestors. When an ingestor is running, it can consume a published test message before a subsequent `MQ LIST` or `MQ PULL` command observes it.
+The MQ commands manage the NATS JetStream task stream used by ingestors.
#### 7.1 MQ SHOW
@@ -569,7 +573,7 @@ RAGFlow(admin)> MQ SHOW;
#### 7.2 MQ LIST
-Lists messages currently retained in the task stream. The optional `PENDING` keyword is accepted by the CLI.
+Lists messages currently retained in the task stream.
**Syntax**