Docs /Command-Line Client

Signing In

climed-client login

It asks for your LeaRes email and password, and for the authenticator code if your account uses two-step verification. It then finds your instance by itself and remembers it, so the other commands need no address.

  logged in as jane.smith@example.org; instance https://your-instance.example.org
  the session lasts one hour and is renewed while you keep working

The sign-in lasts one hour and is renewed automatically every time you run a command close to its end, and between the patients of a long batch.
If your account must change its password, do it once in the web app, then sign in again.
If no instance is assigned to your account, or your instance is switched off, the client says so: ask your administrator.

Check and end the session

Command	Result
`climed-client status`	Who you are, which instance, minutes left
`climed-client logout`	Deletes the saved sign-in from this computer

The saved sign-in is a small file, .climed/session.json in your home folder, readable only by you. Do not share it. logout removes the file; the one-hour sign-in itself simply expires.

Your databases

climed-client databases

lists the databases your account can write to, one per line. Loading commands take -d <database>; if your account has a single database you can leave -d out. With several, the client lists them and asks you to choose: it never guesses.

Other installations

By default the client signs in to the LeaRes cloud and then uses the instance assigned to you. If your organisation runs its own LeaRes server (for example inside a hospital network), your administrator gives you its address, and you point the client at it:

climed-client login --central-url https://leares.example-hospital.org \
                    --api-url https://leares.example-hospital.org

--central-url is where you sign in, --api-url where the data is loaded. On a server of your own they are usually the same.
Addresses must start with https://. Plain http:// is accepted only for localhost (a server running on your own computer) and is refused otherwise, so that your sign-in never travels in clear.
You can also give --api-url to any loading command to override the saved instance for that one run.

Signing in without prompts

For scripts, the sign-in can take its answers from environment variables instead of asking:

Variable	Used for
`CLIMED_EMAIL`	the email (or `--email`)
`CLIMED_PASSWORD`	the password
`CLIMED_MFA_CODE`	the authenticator code, if enabled

export CLIMED_EMAIL=jane.smith@example.org
export CLIMED_PASSWORD='…'            # keep it out of scripts that are shared or stored in a repository
climed-client login

An authenticator code changes every 30 seconds, so accounts with two-step verification are not suited to fully unattended use: use a dedicated account for automation, and give it only the access it needs.

Using a token directly