DeltaTwin Documentation

To use CLI, you need user authentication. To create your account, please visit the DestinE platform website .

Once online registration is done, the user login can be performed via the following command:


deltatwin login USERNAME PASSWORD [options]

Options	Description
-h , —help	Show this message and exit.
-c , —conf `<config_file>`	Path to the configuration file that stores connection user data
-a , —api `<api_url>`	Url to the DeltaTwin® API service. The DeltaTwin® API URL is https://api.deltatwin.destine.eu . It needs to be set at the first connection, then it can be omitted.
-f , —force	Log again the user without using the refresh token.

Special characters

Credentials/Passwords containing special characters (such as !, $, &, etc.) must be escaped or quoted to avoid login errors. Use one of the following methods:

Option 1 — Escape each special character with \:


deltatwin login -a <API_url> <username> P@ssw\!rd\$

Option 2 — Wrap the password in single quotes:


deltatwin login -a <API_url> <username> 'P@ssw!rd$'

Option 3 — Wrap the password in double quotes:


deltatwin login -a <API_url> <username> "P@ssw!rd$"

⚠️ Note: If special characters are not properly handled, the system may fail to read the password correctly, resulting in a failed login attempt.

All connection information is stored in a conf.ini file. The path to this file can be set by the user. You can have an example below.


[SERVICES]
username = jonhdoe
password = p4$$w0rd
api = http://my.api.deltatwin
token = eyJhbGciOiJSUzI1......
token_created = 2024-04-29 17:17:58
expires_in = 3600
refresh_expires_in = 5400
refresh_token = eyJhbGciOiJIUzI1........

username: unique name of the user
password: password of the user
api: URL of the DeltaTwin® service. (The DeltaTwin® API url is https://api.deltatwin.destine.eu .)
token: token of the user
token_created: date of the creation of the token
expires_in: number of seconds to keep the token
refresh_expires_in: duration of the validity of the refresh token
refresh_token: refresh token of the user

Login to the DeltaTwin® service