> For the complete documentation index, see [llms.txt](https://docs.weka.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.weka.io/6.0/getting-started-with-weka/weka-cli-overview/cli-reference-guide.md).

# CLI reference guide

Explore the complete reference for the new WEKA CLI, including commands, subcommands, flags, and environment variables. Use the table or navigation to open a command group.

## Command groups

<table><thead><tr><th width="253.3515625">Group</th><th>Description</th></tr></thead><tbody><tr><td><code>weka agent</code></td><td>Manage the WEKA agent process.</td></tr><tr><td><code>weka alerts</code></td><td>List alerts in the cluster.</td></tr><tr><td><code>weka audit</code></td><td>Manage filesystem and cluster audit services.</td></tr><tr><td><code>weka catalog</code></td><td>Manage the Data Catalog service and indexed filesystem data.</td></tr><tr><td><code>weka cloud</code></td><td>Manage observability via cloud services.</td></tr><tr><td><code>weka cluster</code></td><td>Administer the cluster.</td></tr><tr><td><code>weka completion</code></td><td>Emit, install or remove autocompletion support for this utility.</td></tr><tr><td><code>weka dataservice</code></td><td>Manage dataservice configuration and tasks.</td></tr><tr><td><code>weka diags</code></td><td>Understand the status of the cluster and its environment.</td></tr><tr><td><code>weka driver</code></td><td>Manage WEKA drivers.</td></tr><tr><td><code>weka events</code></td><td>List all events that conform to the filter criteria.</td></tr><tr><td><code>weka fs</code></td><td>List filesystems defined in this cluster.</td></tr><tr><td><code>weka gui</code></td><td>Tools for reaching the cluster's web GUI from the CLI.</td></tr><tr><td><code>weka help</code></td><td>Display detailed help for a given command.</td></tr><tr><td><code>weka local</code></td><td>Control local resources and containers.</td></tr><tr><td><code>weka nfs</code></td><td>Manage the NFS service.</td></tr><tr><td><code>weka profile</code></td><td>Manage profile settings. Profiles are used to configure connection, authentication, and display preferences.</td></tr><tr><td><code>weka prompt</code></td><td>Interactively prompt for commands.</td></tr><tr><td><code>weka s3</code></td><td>Manage the S3 service.</td></tr><tr><td><code>weka security</code></td><td>Security-related commands.</td></tr><tr><td><code>weka smb</code></td><td>Manage SMB file sharing protocol service.</td></tr><tr><td><code>weka stats</code></td><td>Show statistics that conform to the filter criteria. Each statistic and sample is presented in its own row, possibly aggregated.</td></tr><tr><td><code>weka status</code></td><td>Show overall status of the cluster.</td></tr><tr><td><code>weka telemetry</code></td><td>Manage telemetry exports.</td></tr><tr><td><code>weka tenant</code></td><td>List tenants defined in the cluster.</td></tr><tr><td><code>weka upgrade</code></td><td>Control the cluster upgrade process.</td></tr><tr><td><code>weka user</code></td><td>List users defined in the cluster.</td></tr><tr><td><code>weka version</code></td><td>Lists the versions available on this machine.</td></tr></tbody></table>

## Common options

These options are common to most commands and are omitted from the individual command descriptions on the command group pages.

### Connection options

| Parameter                       | Description                                                                                                                                                                                                 |
| ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--CONNECT-TIMEOUT` \<duration> | Timeout for connecting to cluster.                                                                                                                                                                          |
| `-S`, `--CONTAINER` \<string>   | Local container. Connect the named container running on this system.                                                                                                                                        |
| `-H`, `--HOST` \<string>        | Connect to this host. Alternatively, use the WEKA\_HOST env variable.                                                                                                                                       |
| `-P`, `--PORT` \<uint16>        | Connect to this TCP port. Alternatively, use the WEKA\_PORT env variable.                                                                                                                                   |
| `-T`, `--TIMEOUT` \<duration>   | Timeout to wait for response.                                                                                                                                                                               |
| `--auto-accept-cert`            | Auto accept certificates. Skip confirming first certificate from unknown server. Alternatively, use the WEKA\_AUTO\_ACCEPT\_CERT env variable.                                                              |
| `-k`, `--insecure`              | Disable TLS verification. Should only be used if the network is trusted. Alternatively, use the WEKA\_INSECURE env variable.                                                                                |
| `--jump` \<string>              | Tunnel the connection through this SSH jump host, e.g. user\@bastion. Uses the system ssh with your existing \~/.ssh/config, known\_hosts, and agent. Alternatively, use the WEKA\_JUMP\_HOST env variable. |
| `--kube-namespace` \<string>    | Kubernetes namespace of the WEKA management service. Alternatively, use the WEKA\_KUBE\_NAMESPACE env variable.                                                                                             |
| `--kube-weka-cluster` \<string> | Reach this WEKA cluster (by name) through kubectl port-forward to its operator-managed management service. Enables Kubernetes mode. Alternatively, use the WEKA\_KUBE\_CLUSTER env variable.                |
| `--kubeconfig` \<string>        | Path to the kubeconfig file for kubectl port-forward. Defaults to kubectl's own resolution (KUBECONFIG / \~/.kube/config). Alternatively, use the WEKA\_KUBECONFIG env variable.                            |

### Output options

<table><thead><tr><th width="224.26171875">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><code>-U</code>, <code>--UTC</code></td><td>Show times in UTC, instead of in the local timezone.</td></tr><tr><td><code>--accent-color</code> &#x3C;string></td><td>Color to use for accents and titles. Hex code (#FF0000), name ('red'), or a palette index (0-255).</td></tr><tr><td><code>--binary-units</code></td><td>Show storage values in base-2 units (KiB, MiB, GiB) instead of base-10 units (KB, MB, GB).</td></tr><tr><td><code>--brand-color</code> &#x3C;string></td><td>Color to use for branding and decorative elements. Hex code (#FF0000), name ('red'), or a palette index (0-255).</td></tr><tr><td><code>--browser</code></td><td>Display output in a web browser. The output is sent directly to a local browser.</td></tr><tr><td><code>--caption</code> &#x3C;string></td><td>Add a caption to the output.</td></tr><tr><td><code>--classic</code></td><td>Classic text output. Compatible with earlier versions of Weka.</td></tr><tr><td><code>--clip</code></td><td>Limit output to terminal width. No effect if output is not a terminal.</td></tr><tr><td><code>--color</code> &#x3C;color-mode></td><td>Whether to use color in output.</td></tr><tr><td><code>--csv</code></td><td>Output comma-separated values.</td></tr><tr><td><code>--custom-title</code> &#x3C;string></td><td>Add a custom title to the output.</td></tr><tr><td><code>-F</code>, <code>--filter</code> &#x3C;strings>…</td><td>Filter by column value. Prefix with tilde ('~') to negate the filter. Multiple values may be supplied separated by commas, or the option may be repeated.</td></tr><tr><td><code>--filter-color</code> &#x3C;strings>…</td><td>Filter by color. Colors include 'red', 'yellow', 'green', 'brightred', 'brand', and 'accent'. Prefix with '~' to negate filter. Multiple values may be supplied separated by commas, or the option may be repeated.</td></tr><tr><td><code>--footer</code></td><td>Show a summary footer with column totals. Use --footer=false to hide it.</td></tr><tr><td><code>--head</code> &#x3C;int></td><td>Output leading records. Skips this many leading records instead if negative.</td></tr><tr><td><code>--html</code></td><td>HTML output.</td></tr><tr><td><code>-J</code>, <code>--json</code></td><td>JSON output.</td></tr><tr><td><code>--markdown</code></td><td>Markdown output.</td></tr><tr><td><code>--no-header</code></td><td>Omit column headers.</td></tr><tr><td><code>--no-icons</code></td><td>Suppress use of icons for status.</td></tr><tr><td><code>-o</code>, <code>--output</code> &#x3C;strings>…</td><td>Columns to display. May include '+' or '-' before column to add or remove columns. Multiple values may be supplied separated by commas, or the option may be repeated.</td></tr><tr><td><code>--pager</code></td><td>Display output in a pager. Uses built-in pager. Override with WEKA_CLI_PAGER environment variable.</td></tr><tr><td><code>--plain</code></td><td>Plain output. Simple, unadorned without extra colors or decorations. Default when output is not a terminal.</td></tr><tr><td><code>--pretty</code></td><td>Pretty output. Uses a format optimized for readability. Default when output is a terminal.</td></tr><tr><td><code>--profile</code> &#x3C;profile></td><td>Profile name. Configures connection, authentication, and other settings to use.</td></tr><tr><td><code>-R</code>, <code>--raw-units</code></td><td>Show values in raw units. This can be helpful to avoid loss of precision. For example, use bytes instead of GB or GiB.</td></tr><tr><td><code>-s</code>, <code>--sort</code> &#x3C;strings>…</td><td>Column(s) to sort by. May include '+' or '-' before column to sort ascending or descending. Multiple values may be supplied separated by commas, or the option may be repeated.</td></tr><tr><td><code>--tail</code> &#x3C;int></td><td>Output trailing records. Omit this many trailing records if negative.</td></tr><tr><td><code>--title</code></td><td>Show the title in the output.</td></tr><tr><td><code>--tsv</code></td><td>Output tab-separated values.</td></tr><tr><td><code>-v</code>, <code>--verbose</code></td><td>Show verbose output.</td></tr><tr><td><code>--watch</code> &#x3C;duration></td><td>Watch output. Re-runs the command at the specified interval (default 2s).</td></tr><tr><td><code>--width</code> &#x3C;int></td><td>Maximum width of output. Uses terminal width if not specified.</td></tr></tbody></table>

## weka

WEKA Administrative CLI.

```sh
weka [--build] [--check] [--legal] [--licenses] [--opt-in] [--opt-out] [--update] [--version]
```

<table><thead><tr><th width="158.12109375">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><code>--build</code></td><td>Prints build information and exits.</td></tr><tr><td><code>--check</code></td><td>Reports whether a newer CLI has been released, without offering to install it.</td></tr><tr><td><code>--legal</code></td><td>Prints software license information and exits.</td></tr><tr><td><code>--licenses</code></td><td>Prints third-party license information and exits.</td></tr><tr><td><code>--opt-in</code></td><td>Opt in to the new CLI. Replaces /usr/bin/weka.</td></tr><tr><td><code>--opt-out</code></td><td>Opt out of the new CLI. Restores /usr/bin/weka.</td></tr><tr><td><code>--update</code></td><td>Checks whether a newer CLI has been released, and offers to install it.</td></tr><tr><td><code>-v</code>, <code>--version</code></td><td>Prints the CLI version and exits.</td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.weka.io/6.0/getting-started-with-weka/weka-cli-overview/cli-reference-guide.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
