Instalación#

Requisitos#

Linux o macOS; tal vez podría funcionar en Windows
Python 3.11 o superior

Instalación en Linux#

Para distros basadas en Debian (Ubuntu, Mint), instale Python3 con:

$ sudo apt install python3

Para distros basadas en RPM (RHEL, Fedora), instale Python 3 con:

$ sudo dnf install python3

Luego ejecute:

$ python3 -m pip install --user cpanel-cli

Pruebe la instalación con:

$ cpanel --version

Probado en Ubuntu 23.10 “Mantic”, pero no requiere específicamente Ubuntu, por lo que cualquier distribución de Linux con Python 3.11 o superior debería funcionar.

Instalación en macOS#

Instale Python 3 usando Homebrew.

$ brew install python

Luego ejecute:

$ python3 -m pip install --user cpanel-cli

Pruebe la instalación con:

$ cpanel --version

Probado en macOS “Ventura”; también debería funcionar en cualquier release posterior.

¿Se puede usar en Windows?#

cpanel-cli debería funcionar en Windows 10/11 vía WSL 2 (Windows Subsystem for Linux).

Desafortunadamente no tengo acceso a un sistema Windows, así que no puedo confirmarlo.

Autenticación#

Para autenticarse con una instancia de cPanel, lo que se recomienda es crear un archivo de configuración $HOME/.config/cpanel/cpanel.conf.

Si no quiere usar el directorio $HOME/.config/cpanel compatible con XDG, también puede usar un archivo tradicional $HOME/.cpanelrc.

El archivo de configuración debe contener lo siguiente:

hostname=example.com
username=scott
utoken=ABCDEFGHIJKLMNOPQSRTUVWXYZ012345

hostname es el nombre de host de la instancia de cPanel
username es el nombre de usuario en la instancia
utoken es un token de API asociado con username. Véase How to use cPanel API tokens para más información de cómo crear tokens.

Como alternativa, se pueden establecer las siguientes variables de ambiente en el shell:

CPANEL_HOSTNAME
CPANEL_USERNAME
CPANEL_UTOKEN

Por ejemplo:

$ export CPANEL_HOSTNAME=example.com
$ export CPANEL_USERNAME=scott
$ export CPANEL_UTOKEN=ABCDEFGHIJKLMNOPQSRTUVWXYZ012345
$ cpanel list features

También se pueden pasar las credenciales directamente en la línea de comandos con las opciones -H, -U and -T. Por ejemplo:

$ cpanel -H example.com -U scott -T ABCDEFGHIJKLMNOPQSRTUVWXYZ012345 list features

Las opciones pasadas en la línea de comandos tienen precedencia sobre las variables de ambiente, las cuales a su vez tienen precedencia sobre los valores de cpanel.conf o .cpanelrc.

Instalación

Contenido