Interfaz de línea de comandos para cPanel

Interfaz de línea de comandos para cPanel#

Read in English

Una interfaz de línea de comandos para la Unrestricted API de cPanel.

Ejecute comandos rápidamente en una terminal para gestionar un sitio web, evitando la necesidad de iniciar sesión en cPanel y navegar por su interfaz web. Este utilitario también se puede integrar sin problemas en tareas de scripting.

Se implementa una parte de la UAPI (API sin restricciones) de cPanel, lo que le permite realizar una amplia gama de funciones con facilidad.

Algunos ejemplos:

  • Crear una copia de seguridad de la cuenta y almacenarla en el directorio home del usuario remoto:

    $ cpanel create backup home scott@example.com

  • Escribir directamente archivos en el directorio home del usuario remoto:

    $ cpanel write file public_html/index.txt "Hallo\nTschüss\n"

  • Crear un nuevo usuario FTP con una cuota y un directorio personal:

    $ cpanel create ftp bill@example.com 'password' 1024 my_ftp

  • Crear una respuesta automática de correo electrónico:

    $ cpanel set mail autoresponder \
  scott@example.com \
  "Bruce Scott" \
  "This is an automatic message" \
  "I’m currently unavailable, please contact my boss." \
  "Tomorrow 6 PM" \
  "December 15, 8:00 AM"

  • Cambair a francés el idioma de la interfaz de usuario de cPanel:

    $ cpanel set locale fr

  • Listar las características disponibles de cPanel:

    $ cpanel list features

{
    "addoncgi": 0,
    "addondomains": 1,
    "agora": 1,
    . . .
    "webmail": 1,
    "webprotect": 1,
    "zoneedit": 1
}

  • Lista las cuentas de correo de cPanel:

    $ cpanel list mail accounts

  [
      {
      "email": "scott@example.com",
      . . .
      }
  ]

Y muchas cosas más. Con el tiempo espero cubrir completamente las más de 500 funciones disponibles en el API

La salida es JSON, por lo que es fácilmente analizable utilizando un procesador CLI de JSON, como por ejemplo, jq

Consulte la Guía del usuario para una referencia completa de las funciones implementadas de la API.

Guía rápida#

cpanel-cli funciona en Linux y macOS (podría funcionar en Windows) y requiere Python 3.11 o posterior.

Para Linux, instale Python 3.11 o posterior usando el gestor de paquetes de su distro.

Para macOS, instale Python 3.11 o posterior usando Homebrew.

Cree un archivo .cpanelrc en su directorio $HOME con el siguiente contenido:

hostname=example.com
username=scott
utoken=ABCDEFGHIJKLMNOPQSRTUVWXYZ012345

  • hostname es el nombre de host de su instancia de cPanel

  • username es su nombre de usuario en la instancia

  • utoken es un token de API asociado con el username. Lea Cómo crear un token de API.

Luego ejecute:

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

Pruebe la instalación usando:

$ cpanel --version

Para mayores detalles, vea la sección de Instalación de la Guía del usuario.

Guía del usuario#

Para desarrolladores#

Licencia#

CLI para cPanel

GNU General Public License v3