From b9a8c1ff3ac620b93fccfc2e04b9ef3572350b2d Mon Sep 17 00:00:00 2001
From: Aliaksandr Valialkin <valyala@victoriametrics.com>
Date: Thu, 10 Oct 2024 11:48:58 +0200
Subject: [PATCH] docs/VictoriaLogs/querying/vlogscli.md: add the list of
 features of vlogscli

---
 docs/VictoriaLogs/querying/vlogscli.md | 43 +++++++++++++++++++++++---
 1 file changed, 38 insertions(+), 5 deletions(-)

diff --git a/docs/VictoriaLogs/querying/vlogscli.md b/docs/VictoriaLogs/querying/vlogscli.md
index 9515d52dd..8f29f6857 100644
--- a/docs/VictoriaLogs/querying/vlogscli.md
+++ b/docs/VictoriaLogs/querying/vlogscli.md
@@ -9,6 +9,14 @@ menu:
 ---
 
 `vlogsqcli` is an interactive command-line tool for querying [VictoriaLogs](https://docs.victoriametrics.com/victorialogs/).
+It has the following features:
+
+- It supports scrolling and searching over query results in the same way as `less` command does - see [these docs](#scrolling-query-results).
+- It supports canceling long-running queries at any time via `Ctrl+C`.
+- It supports query history - see [these docs](#query-history).
+- It supports diffent formats for query results (JSON, logfmt, compact, etc.) - see [these docs](#output-modes).
+- It supports live tailing - see [these docs](#live-tailing).
+
 This tool can be obtained from the linked release pages at the [changelog](https://docs.victoriametrics.com/victorialogs/changelog/)
 or from [docker images](https://hub.docker.com/r/victoriametrics/vlogscli/tags):
 
@@ -44,12 +52,17 @@ which queries `(AccountID=123, ProjectID=456)` [tenant](https://docs.victoriamet
 ./vlogsql -header='AccountID: 123' -header='ProjectID: 456'
 ```
 
-`AccountID` and `ProjectID` values can be also set via `-accountID` and `-projectID` command-line flags:
+
+## Multitenancy
+
+`AccountID` and `ProjectID` [values](https://docs.victoriametrics.com/victorialogs/#multitenancy)
+can be set via `-accountID` and `-projectID` command-line flags:
 
 ```sh
 ./vlogsql -accountID=123 -projectID=456
 ```
 
+
 ## Querying
 
 After the start `vlogsql` provides a prompt for writing [LogsQL](https://docs.victoriametrics.com/victorialogs/logsql/) queries.
@@ -58,18 +71,33 @@ For example:
 
 ```sh
 ;> _time:1y | count();
-executing [_time:1y | stats count(*) as "count(*)"]...
+executing [_time:1y | stats count(*) as "count(*)"]...; duration: 0.688s
 {
   "count(*)": "1923019991"
 }
-duration: 0.688s
 ```
 
+`vlogscli` shows the actually executed query on the next line after the query input prompt.
+This helps debugging issues related to incorrectly written queries.
+
+The next line after the query input prompt also shows the query duration. This helps debugging
+and optimizing slow queries.
+
 Query execution can be interrupted at any time by pressing `Ctrl+C`.
 
 Type `q` and then press `Enter` for exit from `vlogsql` (if you want to search for `q` [word](https://docs.victoriametrics.com/victorialogs/logsql/#word),
 then just wrap it into quotes: `"q"` or `'q'`).
 
+See also:
+
+- [output modes](#output-modes)
+- [query history](#query-history)
+- [scrolling query results](#scrolling-query-results)
+- [live tailing](#live-tailing)
+
+
+## Scrolling query results
+
 If the query response exceeds vertical screen space, `vlogsql` pipes query response to `less` utility,
 so you can scroll the response as needed. This allows executing queries, which potentially
 may return billions of rows, without any problems at both VictoriaMetrics and `vlogsql` sides,
@@ -89,15 +117,20 @@ See also [`less` docs](https://man7.org/linux/man-pages/man1/less.1.html) and
 
 ## Live tailing
 
-`vlogsql` enters live tailing mode when the query is prepended with `\tail ` command. For example:
+`vlogsql` enters live tailing mode when the query is prepended with `\tail ` command. For example,
+the following query shows all the newly ingested logs with `error` [word](https://docs.victoriametrics.com/victorialogs/logsql/#word)
+in real time:
 
 ```
-;> \tail {kubernetes_container_name="vmagent"};
+;> \tail error;
 ```
 
 By default `vlogscli` derives [the URL for live tailing](https://docs.victoriametrics.com/victorialogs/querying/#live-tailing) from the `-datasource.url` command-line flag
 by replacing `/query` with `/tail` at the end of `-datasource.url`. The URL for live tailing can be specified explicitly via `-tail.url` command-line flag.
 
+Live tailing can show query results in different formats - see [these docs](#output-modes).
+
+
 ## Query history
 
 `vlogsql` supports query history - press `up` and `down` keys for navigating the history.