Login

> cq login --help
Login to a Corridor Quest server

Usage: cq login [OPTIONS] --user-name <USER_NAME>

Options:
  -s, --server <SERVER_URL>  The url of the game server (default: https://server-corridorquest.net, or CQ_SERVER env)
  -u, --user-name <USER_NAME>    The username
  -p, --password <PASSWORD>      The password (prompts if not provided)
  -P, --profile <PROFILE>        The optional profile name

When you are a user (you have signed up to a game server), you can login. This creates a session, which is a shared state between the client where you logged in and the game server. If you start another session between this user and the game server while the user is already logged in (for example from another device) this is possible, but the first session is then invalidated.

Most commands can only be done when the user is logged in. Exceptions are signup and password change. Both are protected by validation using a second factor.

As you can see above you need to provide 2 arguments: your username and your password. If you do not specify the password you will be prompted.

Again, the --server option is optional. If not given, the default is used.

Once you have successfully logged in, both username and server-url are stored in a local profile which means that for subsequent commands you do not need to supply them.