OS Manuals

/usr/bin/weaviate

Weaviate is an open source vector database that stores both objects and vectors, allowing for combining vector search with structured filtering with the fault-tolerance and scalability of a cloud-native database, all accessible through GraphQL, REST, and various language clients.

From weaviate 1.38.0-r0 (os), captured 2026-11-05 by running weaviate --help (exit 0). permalink

Also provided by 1 other package version
Usage:
  weaviate [OPTIONS]

# Introduction<br/> Weaviate is an open source, AI-native vector database that
helps developers create intuitive and reliable AI-powered applications. <br/>
### Base Path <br/>The base path for the Weaviate server is structured as
`[YOUR-WEAVIATE-HOST]:[PORT]/v1`. As an example, if you wish to access the
`schema` endpoint on a local instance, you would navigate to
`http://localhost:8080/v1/schema`. Ensure you replace `[YOUR-WEAVIATE-HOST]`
and `[PORT]` with your actual server host and port number respectively. <br/>
### Questions? <br/>If you have any comments or questions, please feel free to
reach out to us at the community forum
[https://forum.weaviate.io/](https://forum.weaviate.io/). <br/>### Issues?
<br/>If you find a bug or want to file a feature request, please open an issue
on our GitHub repository for [Weaviate](https://github.com/weaviate/weaviate).
<br/>### Need more documentation? <br/>For a quickstart, code examples,
concepts and more, please visit our [documentation
page](https://docs.weaviate.io/weaviate).

Application Options:
      --scheme=                          the listeners to enable, this can be
                                         repeated and defaults to the schemes
                                         in the swagger spec
      --cleanup-timeout=                 grace period for which to wait before
                                         killing idle connections (default: 10s)
      --graceful-timeout=                grace period for which to wait before
                                         shutting down the server (default: 15s)
      --max-header-size=                 controls the maximum number of bytes
                                         the server will read parsing the
                                         request header's keys and values,
                                         including the request line. It does
                                         not limit the size of the request
                                         body. (default: 1MiB)
      --socket-path=                     the unix socket to listen on (default:
                                         /var/run/weaviate.sock)
      --host=                            the IP to listen on (default:
                                         localhost) [$HOST]
      --port=                            the port to listen on for insecure
                                         connections, defaults to a random
                                         value [$PORT]
      --listen-limit=                    limit the number of outstanding
                                         requests
      --keep-alive=                      sets the TCP keep-alive timeouts on
                                         accepted connections. It prunes dead
                                         TCP connections ( e.g. closing laptop
                                         mid-download) (default: 3m)
      --read-timeout=                    maximum duration before timing out
                                         read of the request (default: 30s)
      --write-timeout=                   maximum duration before timing out
                                         write of the response (default: 60s)
      --tls-host=                        the IP to listen on for tls, when not
                                         specified it's the same as --host
                                         [$TLS_HOST]
      --tls-port=                        the port to listen on for secure
                                         connections, defaults to a random
                                         value [$TLS_PORT]
      --tls-certificate=                 the certificate to use for secure
                                         connections [$TLS_CERTIFICATE]
      --tls-key=                         the private key to use for secure
                                         connections [$TLS_PRIVATE_KEY]
      --tls-ca=                          the certificate authority file to be
                                         used with mutual tls auth
                                         [$TLS_CA_CERTIFICATE]
      --tls-listen-limit=                limit the number of outstanding
                                         requests
      --tls-keep-alive=                  sets the TCP keep-alive timeouts on
                                         accepted connections. It prunes dead
                                         TCP connections ( e.g. closing laptop
                                         mid-download)
      --tls-read-timeout=                maximum duration before timing out
                                         read of the request
      --tls-write-timeout=               maximum duration before timing out
                                         write of the response

Connector, raft & MQTT config:
      --config-file=                     path to config file (default:
                                         ./weaviate.conf.json)
      --raft-port=                       the port used by Raft for inter-node
                                         communication
      --raft-internal-rpc-port=          the port used for internal RPCs within
                                         the cluster
      --raft-rpc-message-max-size=       maximum internal raft grpc message
                                         size in bytes, defaults to 1073741824
      --raft-join=                       a comma-separated list of server
                                         addresses to join on startup. Each
                                         element needs to be in the form
                                         NODE_NAME[:NODE_PORT]. If NODE_PORT is
                                         not present, raft-internal-rpc-port
                                         default value will be used instead
      --raft-bootstrap-timeout=          the duration for which the raft
                                         bootstrap procedure will wait for each
                                         node in raft-join to be reachable
      --raft-bootstrap-expect=           specifies the number of server nodes
                                         to wait for before bootstrapping the
                                         cluster
      --raft-heartbeat-timeout=          raft heartbeat timeout
      --raft-election-timeout=           raft election timeout
      --raft-snap-threshold=             number of outstanding log entries
                                         before performing a snapshot
      --raft-snap-interval=              controls how often raft checks if it
                                         should perform a snapshot
      --raft-metadata-only-voters        configures the voters to store
                                         metadata exclusively, without storing
                                         any other data
      --runtime-overrides.enabled        enable runtime overrides config
      --runtime-overrides.path=          path to runtime overrides config
      --runtime-overrides.load-interval= load interval for runtime overrides
                                         config

Help Options:
  -h, --help                             Show this help message
Options (35)
OptionDescriptionSource
--schemethe listeners to enable, this can be repeated and defaults to the schemes in the swagger spechelp
--cleanup-timeoutgrace period for which to wait before killing idle connections (default: 10s)help
--graceful-timeoutgrace period for which to wait before shutting down the server (default: 15s)help
--max-header-sizecontrols the maximum number of bytes the server will read parsing the request header's keys and values, including the request line.help
--socket-paththe unix socket to listen on (default: /var/run/weaviate.sock)help
--hostthe IP to listen on (default: localhost) [$HOST]help
--portthe port to listen on for insecure connections, defaults to a random value [$PORT]help
--listen-limitlimit the number of outstanding requestshelp
--keep-alivesets the TCP keep-alive timeouts on accepted connections.help
--read-timeoutmaximum duration before timing out read of the request (default: 30s)help
--write-timeoutmaximum duration before timing out write of the response (default: 60s)help
--tls-hostthe IP to listen on for tls, when not specified it's the same as --host [$TLS_HOST]help
--tls-portthe port to listen on for secure connections, defaults to a random value [$TLS_PORT]help
--tls-certificatethe certificate to use for secure connections [$TLS_CERTIFICATE]help
--tls-keythe private key to use for secure connections [$TLS_PRIVATE_KEY]help
--tls-cathe certificate authority file to be used with mutual tls auth [$TLS_CA_CERTIFICATE]help
--tls-listen-limitlimit the number of outstanding requestshelp
--tls-keep-alivesets the TCP keep-alive timeouts on accepted connections.help
--tls-read-timeoutmaximum duration before timing out read of the requesthelp
--tls-write-timeoutmaximum duration before timing out write of the responsehelp
--config-filepath to config file (default: ./weaviate.conf.json)help
--raft-portthe port used by Raft for inter-node communicationhelp
--raft-internal-rpc-portthe port used for internal RPCs within the clusterhelp
--raft-rpc-message-max-sizemaximum internal raft grpc message size in bytes, defaults to 1073741824help
--raft-joina comma-separated list of server addresses to join on startup.help
--raft-bootstrap-timeoutthe duration for which the raft bootstrap procedure will wait for each node in raft-join to be reachablehelp
--raft-bootstrap-expectspecifies the number of server nodes to wait for before bootstrapping the clusterhelp
--raft-heartbeat-timeoutraft heartbeat timeouthelp
--raft-election-timeoutraft election timeouthelp
--raft-snap-thresholdnumber of outstanding log entries before performing a snapshothelp
--raft-snap-intervalcontrols how often raft checks if it should perform a snapshothelp
--raft-metadata-only-votersconfigures the voters to store metadata exclusively, without storing any other datahelp
--runtime-overrides.enabledenable runtime overrides confighelp
--runtime-overrides.pathpath to runtime overrides confighelp
-h, --helpShow this help messagehelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.