diff options
| -rw-r--r-- | docs/cli/index.rst | 30 |
1 files changed, 28 insertions, 2 deletions
diff --git a/docs/cli/index.rst b/docs/cli/index.rst index 130a1601..8ea7801a 100644 --- a/docs/cli/index.rst +++ b/docs/cli/index.rst @@ -7,7 +7,33 @@ Bitmask CLI ================================ -The command line interface +``bitmaskctl`` is the command line interface. -Using bitmask from the command line +It will try to launch the bitmask backend. + +Creating an user +----------------------------------- + +:: + + bitmaskctl user create user@example.org + +If the provider needs invite codes to register new users, you can pass one:: + + bitmaskctl user create --invitecode xxxxxxx user@example.org + + +Authenticating ----------------------------------- + +To authenticate, start a session and start configured services:: + + bitmaskctl user auth user@example.org + + +Uploading logs +--------------- + +(This needs ``pastebinit`` installed in your system) :: + + bitmaskctl logs send |