Authorize ArvanCLI

After installing the ArvanCLI, you need to perform initial steps such as login and authentication.

Login

To log in, use the auth login command:

arvan auth login

You will be prompted to enter a machine user API key from the workspace you want to operate on.

To log in, you need to have a Machine user. If you don't have one, you can create it from the Arvancloud panel. For more details, refer to the Arvancloud machine user documentation.

The login process creates an authentication profile on your local machine. This profile stores your credentials securely.

Any operations you do in ArvanCLI are actually done on behalf of the created machine user, so make sure the proper IAM roles are granted to the machine user for specific tasks you want to do with ArvanCLI. For more details about granting IAM roles, refer to the Arvancloud IAM policies documentation.

Verify Login & User Info

To check the details of your currently active logged-in session and workspace information, use:

arvan auth whoami 

This command displays details about the machine user identity and its workspace information.

Manage Profiles

To see all configured authentication profiles, run:

arvan auth list

This will display a list of workspace IDs and their associated names.

Credentials and profile information are stored in a configuration file located at ~/.config/arvan/config.yaml (or the OS-equivalent user configuration directory, e.g., %APPDATA%\Arvan\config.yaml on Windows, ~/Library/Application Support/arvan/config.yaml on macOS)

Credentials are stored securely using your operating system's native credential manager (like MacOS Keychain, Windows Credential Manager, or Linux D-Bus Secret Service)

Logout

To log out from the current profile, use:

arvan auth logout

If you have multiple profiles, logging out will switch to another available profile if one exists. Otherwise, it will clear the current profile.