Realm CLI Notes

rcli.md

Basic Setup

• To install the cli, you will do npm install -g realm-cli
• To aim the cli at a host you can do it either of 3 ways
  1. realm-cli -h "localhost:9080" ..args
  2. realm-cli -host "localhost:9080"" ...args
  3. To set a host for future commands simply call realm-cli use "localhost:9080"
  4. To clear a host realm-cli use "" or realm-cli use

Controlling a Service

Services are hosted by a service host. Generally an express app that is running as a a simple http/websocket server.

All services must have a way to:

1. start realm-cli -host "localhost:9080"" -s "auth" start
2. stop realm-cli -host "localhost:9080"" -s "auth" stop
3. get status realm-cli -host "localhost:9080"" -s "auth" status
4. observe status realm-cli -host "localhost:9080"" -s "auth" -watch status
5. observe log realm-cli -host "localhost:9080"" -s "auth" -watch log

Service Specific Commands

You can pass a service name to use or disuse `realm-cli -h "localhost:9080" -s "auth" -change-password -u "max.alexander@realm.io" -p "ilovesushi"