| Overview |  |
| create_test_dir/0 | |
| delete_test_dir/1 | |
| ensure_stopped/0 | |
| print/2 | Take a list of status types and generate console output. |
| register/1 | |
| register_command/4 | Register a cli command (e.g.: "riak-admin handoff status", or "riak-admin cluster join '*'"). |
| register_config/2 | Register configuration callbacks for a given config key. |
| register_config_whitelist/1 | Register a list of configuration variables that are settable. |
| register_formatter/2 | Register a configuration formatter for a given config key. |
| register_node_finder/1 | RPC calls when using the --all flag need a list of nodes to contact. |
| register_usage/2 | Register usage for a given command sequence. |
| register_writer/2 | Register a module for writing output in a specific format. |
| run/1 | Run a config operation or command. |
create_test_dir() -> string() | no_return()
delete_test_dir(Dir::string()) -> ok | no_return()
ensure_stopped() -> ok
print(E::{error, term()}, Cmd::term()) -> {error, 1}
print(E::{clique_status:status(), integer(), string()}, Cmd::[string()]) -> ok | {error, integer()}
print(E::clique_status:status(), Cmd::[string()]) -> ok
Take a list of status types and generate console output
register(Modules::[module()]) -> ok
register_command(Cmd::['*' | string()], Keys::'_' | list(), Flags::list(), Fun::function()) -> ok | {error, atom()}
Register a cli command (e.g.: "riak-admin handoff status", or "riak-admin cluster join '*'")
register_config(Key::[string()], Callback::function()) -> true
Register configuration callbacks for a given config key
register_config_whitelist(SettableKeys::[string()]) -> ok | {error, {invalid_config_keys, [string()]}}
Register a list of configuration variables that are settable. Clique disallows setting of all config variables by default. They must be in whitelist to be settable.
register_formatter(Key::[string()], Callback::function()) -> true
Register a configuration formatter for a given config key
register_node_finder(Fun::function()) -> true
RPC calls when using the --all flag need a list of nodes to contact. However, using nodes() only provides currently connected nodes. We want to also report an alert for nodes that are not currently available instead of just ignoring them. This allows the caller to define how we find the list of cluster member nodes.
register_usage(Cmd::[string()], Usage::clique_usage:usage()) -> true
Register usage for a given command sequence. Lookups are by longest match.
register_writer(Name::string(), Module::module()) -> true
Register a module for writing output in a specific format
run(Cmd::[string()]) -> ok | {error, integer()}
Run a config operation or command
Generated by EDoc