matrixtool client login - Obtain a client authentication token


   $ matrixtool client login


This command performs the /login steps of the Matrix client API, obtaining an access token for the given user ID. This requires a password - either provided on the commandline as a second argument, or requested interactively on the terminal.

Once the access token is obtained it is stored in the token cache, which lives in $HOME/.matrix/client-tokens. This cache will be consulted by other matrixtool client sub-commands to automatically provide the access token if required.

Note that the interactive terminal method requires the optional dependency of IO::Termios to be installed, so that local echo can temporarily be disabled while the user types in the password.


Paul Evans <>