CLI - Getting Started
The PERIAN CLI is a developer tool to help you request and manage instances directly from the command line.
Requirements
Make sure you have Python version 3.10, 3.11 or 3.12 installed on your system.
Setting Up Your Environment
(Optional) setup a python virtual environment:
conda create -n venv python=3.10 -y && conda activate venv for more information please visit miniconda installation page
1. Install the CLI
To start using the PERIAN CLI, you need to install it from PyPI. You can install it using pip:
pip install perian-cli2. Enable Autocompletion
perian --install-completion3. Log into Your Account
Before using any CLI commands, you need to log into your account:
Before using any CLI commands, you need to log into your account:
perian loginEnter your credentials when prompted. The exact login details can be found in your 'Welcome' mail.
4. Configuring the CLI
To add private container registries:
To add private container registries:
perian config registry add [username] [password] [registry-url] [registry-name]- Replace [registry-url] with the actual URL of your container registry and do not forget 'https://'.
- Replace [username] and [password] with your authentication information.
- Optionally add a [registry-name], this will be 'default' by default.
(Hint: generate a Docker hub token) Tokens are more secure and can be generated in Docker Hub settings. - The registry information will be automatically added to all later created jobs with the same container registry url.
