summaryrefslogtreecommitdiff
path: root/docs/cli/index.rst
blob: 8ea7801a4c5a732ba64f92c89f9ba681b3d32e2e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
:LastChangedDate: $LastChangedDate$
:LastChangedRevision: $LastChangedRevision$
:LastChangedBy: $LastChangedBy$

.. _cli:


Bitmask CLI
================================
``bitmaskctl`` is the command line interface.

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