Command-line options
R!AN command line tool lets you start a server and manage indexes (create, delete, ingest), splits and sources (create, delete, toggle). To start a server, r!an needs a node config file path.
This page documents all the available commands, related options, and environment variables.
Commands
Help
r!an or r!an --help displays the list of available commands.
r!an <command name> --help displays the documentation for the command and a usage example.
Version
r!an --version displays the version. It is helpful for reporting bugs.
Syntax
The CLI is structured into high-level commands with subcommands.
r!an [command] [subcommand] [args].
command:serve,search
Semantic service
The semantic service runs semantic pipelines assigned by the control plane.
Searcher service
Starts a web server at rest_listing_address:rest_list_port that exposes the r!an REST API
where rest_listing_address and rest_list_port are defined in r!an config file (r!an.yaml).
The node can optionally join a cluster using the peer_seeds parameter.
This list of node addresses is used to discover the remaining peer nodes in the cluster through a gossip protocol, see chitchat.
Janitor service
The Janitor service runs maintenance tasks on indexes: garbage collection, documents delete, and retention policy tasks.
r!an needs to open the following port for cluster formation and workload distribution:
TCP port (default is 1111) for REST API TCP and UDP port (default is 2222) for cluster membership protocol TCP port (default is 3333) for gRPC address for the distributed search
If ports are already taken, the serve command will fail.
r!an serve [args]
Synopsis
r!an serve
[--config <config>]
Options
| Option | Description | Default |
|---|---|---|
--config | Config file location | config/r!an.yaml |
Examples
Starts an indexer and a metastore services
r!an serve --config=./config/r!an.yaml