CLI First Use
This section describes how to use CLI for the first time. It includes information on simple account management and terms of conditions acceptance.
Elympics CLI is in active development and therefore is a subject to rapid change.
Please update the tool regularly and refer to --help flag if you find documentation outdated.
Registration
To begin operating in the Elympics CLI environment, you need an account.
You can create such an account with the elympics auth register -e <email> command.
You will be prompted to provide a password.
To better identify your organization, you can pass its name, address or tax info, using --name, --address or --tax-info options respectively, for example:
elympics auth register -e [email protected] --name "My Company"`
After successful registration, you'll be logged in to your new account immediately. However, the account needs to be confirmed to be fully operational. You can find confirmation link in your email box.
Registration method described above creates a new organization and sets the new account as its administrator.
If you want to create more accounts within the same organization (and share it with your developers), check the article about managing organizations.
Logging in
If you have an account already, use the elympics auth login -u <username> command.
For account created using the method described above, you should use your email address as the username.
Signing to another account does not require logging out first.
Checking login status
To check whether you are logged in or not, you can run the elympics hello command.
It will provide you with a welcoming message and current username:
Hello, <your-username>!
Logging out
Accordingly, logout is done with the elympics auth logout command.
Resetting password
If you've received an account with a default password set by your organization administrator, you should reset the password before you start using the account.
This can be done with the elympics auth forgot-password -e <email> command. You don't have to be logged in before running the command.
After you receive password reset confirmation link via email, copy it and use it in the elympics auth reset-password -e <email> -t <password reset link> command. The command will ask you for a new password.
While our panel is undergoing maintenance, the link does not work correctly. Therefore you should not click it as instructed in the email, but copy it to the CLI instead.
The same commands can be used if you forget your password. As long as you have access to the email address used to create the account, you'll be able to set a new password.
Terms and conditions
To use majority of the features of the Elympics CLI Tool, you will be required to accept the newest terms and conditions.
You can retrieve the current version through elympics terms get, which will yield the same content as terms and conditions on our site.
Future changes to terms and conditions will require you to accept the updated version.
Then, to accept them use the elympics terms accept -v <version>. For example accepting the 1.0.0 version will result in the following response:
Terms and conditions version: 1.0.0 accepted