This is a description of the Riak command-line tools and their subcommands. These tools are located in the bin directory of an embedded node, and the path when installed from a package (usually /usr/sbin or /usr/local/sbin).

riak

riak is the primary script for controlling the Riak node process. The following subcommands are avaiable:

• start
• stop
• restart
• reboot
• ping
• console
• attach
• chkconfig

riak-admin

riak-admin performs operations not related to node-liveness, including node membership, backup, and basic status reporting. The node must be running for most of these commands to work. The following subcommands are supported:

• join
• leave
• backup
• restore
• test
• status
• reip
• js_reload
• wait-for-service
• services
• ringready
• transfers
• force-remove
• down
• cluster_info
• member_status
• ring_status
• vnode-status

search-cmd

search-cmd is used to interact with the Search functionality included with Riak. The following subcommands are supported:

• set-schema
• show-schema
• clear-schema-cache
• search
• search-doc
• explain
• index
• delete
• solr
• install
• uninstall
• test