.. image:: https://img.shields.io/pypi/v/cpanel-cli
:alt: PyPI
:target: https://pypi.org/project/cpanel-cli/
.. image:: https://img.shields.io/pypi/pyversions/cpanel-cli
:alt: Python version
:target: https://pypi.org/project/cpanel-cli/
.. image:: https://readthedocs.org/projects/cpanel-cli/badge/?version=latest
:alt: Documentation Status
:target: https://cpanel-cli.readthedocs.io/en/latest/?badge=latest
=============================
cPanel Command Line Interface
=============================
|cpanel_cli_icon|
`LÉAME en español <#interfaz-de-linea-de-comandos-para-cpanel>`_
A command line interface for the cPanel Unrestricted API.
Swiftly execute commands in a terminal to manage a website, bypassing the need to log
into `cPanel`_ and navigate through its web interface. This utility can also be
seamlessly integrated into scripting tasks.
.. _cPanel: https://en.wikipedia.org/wiki/CPanel
A portion of the cPanel UAPI (Unrestricted API) is implemented, enabling you to
perform a wide array of functions with ease.
.. |cpanel_cli_icon| image:: https://raw.githubusercontent.com/layfellow/cpanel-cli/master/doc/_static/cpanel-cli-salmon.svg
:width: 100
:align: bottom
Some examples:
- Create a backup of the account and store it in the remote user's home directory:
.. code:: sh
$ cpanel create backup home scott@example.com
- Directly write files to the remote user's home directory:
.. code:: sh
$ cpanel write file public_html/index.txt "Hallo\nTschüss\n"
- Create a new FTP user with a quota and personal directory:
.. code:: sh
$ cpanel create ftp bill@example.com 'password' 1024 my_ftp
- Create an email autoresponder:
.. code:: sh
$ 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"
- Set the cPanel user interface language to French:
.. code:: sh
$ cpanel set locale fr
- List cPanel available features:
.. code:: sh
$ cpanel list features
{
"addoncgi": 0,
"addondomains": 1,
"agora": 1,
. . .
"webmail": 1,
"webprotect": 1,
"zoneedit": 1
}
- List cPanel email accounts:
.. code:: sh
$ cpanel list mail accounts
[
{
"email": "scott@example.com",
. . .
}
]
And many more things. I intend to eventually fully cover the 500+ API
functions available.
The output is JSON, so it’s easily parsable using a `CLI JSON processor, like jq`_
.. _`CLI JSON processor, like jq`: https://stedolan.github.io/jq/
See the User’s `Guide`_ for a complete reference of the implemented API
functions.
.. _`Guide`: https://cpanel-cli.readthedocs.io/en/stable/
Quick Start Guide
=================
**cpanel-cli** works on Linux and macOS (it might work on `Windows`_) and
requires Python 3.11 or later.
For Linux, install Python 3.11 or later using your distro’s package manager.
For macOS, install Python 3.11 or later using Homebrew_.
.. _`Windows`: #what-about-windows
.. _Homebrew: https://brew.sh/
Create a ``.cpanelrc`` file in your ``$HOME`` directory with the following contents:
.. code:: sh
hostname=example.com
username=scott
utoken=ABCDEFGHIJKLMNOPQSRTUVWXYZ012345
- ``hostname`` is the hostname of your cPanel instance
- ``username`` is your username in your instance
- ``utoken`` is an API token associated with ``username``. See `How to create an API token`_.
.. _`How to create an API token`: https://docs.cpanel.net/knowledge-base/security/how-to-use-cpanel-api-tokens/#create-an-api-token
Then run:
.. code:: sh
$ python3 -m pip install --user cpanel-cli
Test the installation using:
.. code:: sh
$ cpanel --version
User’s Guide
============
See the User’s Guide at https://cpanel-cli.readthedocs.io/en/stable/ for detailed
installation and configuration instructions, as well as a complete reference of the
implemented API functions.
Contributing
============
Pull requests are more than welcome. See `CONTRIBUTING`_ for a detailed guide on
how to collaborate with this project.
.. _`CONTRIBUTING`: https://github.com/layfellow/cpanel-cli/blob/main/CONTRIBUTING.rst
What about Windows?
===================
**cpanel-cli** should work on Windows 10/11 using `WSL 2`_ (Windows Subsystem for Linux).
.. _`WSL 2`: https://docs.microsoft.com/en-us/windows/wsl/about
Unfortunately I don’t have access to a Windows system, so I can’t confirm this.
----
.. image:: https://img.shields.io/pypi/v/cpanel-cli
:alt: PyPI
:target: https://pypi.org/project/cpanel-cli/
.. image:: https://img.shields.io/pypi/pyversions/cpanel-cli
:alt: Versión de Python
:target: https://pypi.org/project/cpanel-cli/
.. image:: https://readthedocs.org/projects/cpanel-cli/badge/?version=latest
:alt: Status de la documentación
:target: https://cpanel-cli.readthedocs.io/es/latest/?badge=latest
=========================================
Interfaz de línea de comandos para cPanel
=========================================
|cpanel_cli_icon|
`README in English <#cpanel-command-line-interface>`_
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. Esta utilidad 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:
.. code:: sh
$ cpanel create backup home scott@example.com
- Escribir directamente archivos en el directorio home del usuario remoto:
.. code:: sh
$ cpanel write file public_html/index.txt "Hallo\nTschüss\n"
- Crear un nuevo usuario FTP con una cuota y un directorio personal:
.. code:: sh
$ cpanel create ftp bill@example.com 'password' 1024 my_ftp
- Crear una respuesta automática de correo electrónico:
.. code:: sh
$ cpanel set mail autoresponder \
scott@example.com \
"Bruce Scott" \
"Este es mensaje automático" \
"No estoy disponible por el momento, por favor contacte a mi jefe." \
"Tomorrow 6 PM" \
"December 15, 8:00 AM"
- Cambiar a francés el idioma de la interfaz de usuario de cPanel:
.. code:: sh
$ cpanel set locale fr
- Listar las características disponibles de cPanel:
.. code:: sh
$ cpanel list features
{
"addoncgi": 0,
"addondomains": 1,
"agora": 1,
. . .
"webmail": 1,
"webprotect": 1,
"zoneedit": 1
}
- Listar las cuentas de correo electrónico de cPanel:
.. code:: sh
$ 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`_
.. _`procesador CLI de JSON, como por ejemplo jq`: https://stedolan.github.io/jq/
Consulte la `Guía`_ del usuario para una referencia completa de las
funciones implementadas de la API.
.. _`Guía`: https://cpanel-cli.readthedocs.io/es/stable/
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 utilizando el gestor de paquetes
de su distro.
Para macOS, instale Python 3.11 o posterior usando Homebrew_.
.. _`en Windows`: #se-puede-usar-en-windows
Cree un archivo ``.cpanelrc`` en su directorio ``$HOME`` con el siguiente contenido:
.. code:: sh
hostname=example.com
username=scott
utoken=ABCDEFGHIJKLMNOPQSRTUVWXYZ012345
- ``hostname`` es el nombre de host su instancia de cPanel
- ``username`` es su nombre de usuario en la instancia
- ``utoken`` es un token API asociado con el ``username``. Lea `cómo crear un token API`_.
.. _`cómo crear un token API`: https://docs.cpanel.net/knowledge-base/security/how-to-use-cpanel-api-tokens/#create-an-api-token
A continuación, ejecute:
.. code:: sh
$ python3 -m pip install --user cpanel-cli
Pruebe la instalación:
.. code:: sh
$ cpanel --version
Guía del usuario
================
Consulte la Guía del usuario en https://cpanel-cli.readthedocs.io/es/stable/
para instrucciones detalladas de instalación y configuración, así
como una referencia completa de las funciones implementadas del API.
Cómo contribuir
===============
Los pull requests son más que bienvenidos. Consulte `CONTRIBUTING en español`_
para una guía detallada de cómo colaborar con este proyecto.
.. _`CONTRIBUTING en español`: https://github.com/layfellow/cpanel-cli/blob/main/CONTRIBUTING.rst#como-contribuir
¿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.
Raw data
{
"_id": null,
"home_page": null,
"name": "cpanel-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "cli, command-line, cpanel, hosting",
"author": null,
"author_email": "Marco Bravo Mej\u00edas <marco@layfellow.net>",
"download_url": "https://files.pythonhosted.org/packages/7b/cf/9ba27c82503aaa4660a44522d55201d791ab23ffffa9d882dbca8b414be7/cpanel_cli-0.29.tar.gz",
"platform": null,
"description": ".. image:: https://img.shields.io/pypi/v/cpanel-cli\n :alt: PyPI\n :target: https://pypi.org/project/cpanel-cli/\n\n.. image:: https://img.shields.io/pypi/pyversions/cpanel-cli\n :alt: Python version\n :target: https://pypi.org/project/cpanel-cli/\n\n.. image:: https://readthedocs.org/projects/cpanel-cli/badge/?version=latest\n :alt: Documentation Status\n :target: https://cpanel-cli.readthedocs.io/en/latest/?badge=latest\n\n=============================\ncPanel Command Line Interface\n=============================\n\n|cpanel_cli_icon|\n\n`L\u00c9AME en espa\u00f1ol <#interfaz-de-linea-de-comandos-para-cpanel>`_\n\nA command line interface for the cPanel Unrestricted API.\n\nSwiftly execute commands in a terminal to manage a website, bypassing the need to log\ninto `cPanel`_ and navigate through its web interface. This utility can also be\nseamlessly integrated into scripting tasks.\n\n.. _cPanel: https://en.wikipedia.org/wiki/CPanel\n\nA portion of the cPanel UAPI (Unrestricted API) is implemented, enabling you to\nperform a wide array of functions with ease.\n\n.. |cpanel_cli_icon| image:: https://raw.githubusercontent.com/layfellow/cpanel-cli/master/doc/_static/cpanel-cli-salmon.svg\n :width: 100\n :align: bottom\n\nSome examples:\n\n- Create a backup of the account and store it in the remote user's home directory:\n\n .. code:: sh\n\n $ cpanel create backup home scott@example.com\n\n- Directly write files to the remote user's home directory:\n\n .. code:: sh\n\n $ cpanel write file public_html/index.txt \"Hallo\\nTsch\u00fcss\\n\"\n\n- Create a new FTP user with a quota and personal directory:\n\n .. code:: sh\n\n $ cpanel create ftp bill@example.com 'password' 1024 my_ftp\n\n- Create an email autoresponder:\n\n .. code:: sh\n\n $ cpanel set mail autoresponder \\\n scott@example.com \\\n \"Bruce Scott\" \\\n \"This is an automatic message\" \\\n \"I\u2019m currently unavailable, please contact my boss.\" \\\n \"Tomorrow 6 PM\" \\\n \"December 15, 8:00 AM\"\n\n- Set the cPanel user interface language to French:\n\n .. code:: sh\n\n $ cpanel set locale fr\n\n- List cPanel available features:\n\n .. code:: sh\n\n $ cpanel list features\n\n {\n \"addoncgi\": 0,\n \"addondomains\": 1,\n \"agora\": 1,\n . . .\n \"webmail\": 1,\n \"webprotect\": 1,\n \"zoneedit\": 1\n }\n\n- List cPanel email accounts:\n\n .. code:: sh\n\n $ cpanel list mail accounts\n\n [\n {\n \"email\": \"scott@example.com\",\n . . .\n }\n ]\n\nAnd many more things. I intend to eventually fully cover the 500+ API\nfunctions available.\n\nThe output is JSON, so it\u2019s easily parsable using a `CLI JSON processor, like jq`_\n\n.. _`CLI JSON processor, like jq`: https://stedolan.github.io/jq/\n\nSee the User\u2019s `Guide`_ for a complete reference of the implemented API\nfunctions.\n\n.. _`Guide`: https://cpanel-cli.readthedocs.io/en/stable/\n\nQuick Start Guide\n=================\n\n**cpanel-cli** works on Linux and macOS (it might work on `Windows`_) and\nrequires Python 3.11 or later.\n\nFor Linux, install Python 3.11 or later using your distro\u2019s package manager.\n\nFor macOS, install Python 3.11 or later using Homebrew_.\n\n.. _`Windows`: #what-about-windows\n\n.. _Homebrew: https://brew.sh/\n\nCreate a ``.cpanelrc`` file in your ``$HOME`` directory with the following contents:\n\n .. code:: sh\n\n hostname=example.com\n username=scott\n utoken=ABCDEFGHIJKLMNOPQSRTUVWXYZ012345\n\n- ``hostname`` is the hostname of your cPanel instance\n- ``username`` is your username in your instance\n- ``utoken`` is an API token associated with ``username``. See `How to create an API token`_.\n\n.. _`How to create an API token`: https://docs.cpanel.net/knowledge-base/security/how-to-use-cpanel-api-tokens/#create-an-api-token\n\nThen run:\n\n.. code:: sh\n\n $ python3 -m pip install --user cpanel-cli\n\n\nTest the installation using:\n\n.. code:: sh\n\n $ cpanel --version\n\nUser\u2019s Guide\n============\n\nSee the User\u2019s Guide at https://cpanel-cli.readthedocs.io/en/stable/ for detailed\ninstallation and configuration instructions, as well as a complete reference of the\nimplemented API functions.\n\n\nContributing\n============\n\nPull requests are more than welcome. See `CONTRIBUTING`_ for a detailed guide on\nhow to collaborate with this project.\n\n.. _`CONTRIBUTING`: https://github.com/layfellow/cpanel-cli/blob/main/CONTRIBUTING.rst\n\nWhat about Windows?\n===================\n\n**cpanel-cli** should work on Windows 10/11 using `WSL 2`_ (Windows Subsystem for Linux).\n\n.. _`WSL 2`: https://docs.microsoft.com/en-us/windows/wsl/about\n\nUnfortunately I don\u2019t have access to a Windows system, so I can\u2019t confirm this.\n\n\n----\n\n\n.. image:: https://img.shields.io/pypi/v/cpanel-cli\n :alt: PyPI\n :target: https://pypi.org/project/cpanel-cli/\n\n.. image:: https://img.shields.io/pypi/pyversions/cpanel-cli\n :alt: Versi\u00f3n de Python\n :target: https://pypi.org/project/cpanel-cli/\n\n.. image:: https://readthedocs.org/projects/cpanel-cli/badge/?version=latest\n :alt: Status de la documentaci\u00f3n\n :target: https://cpanel-cli.readthedocs.io/es/latest/?badge=latest\n\n=========================================\nInterfaz de l\u00ednea de comandos para cPanel\n=========================================\n\n|cpanel_cli_icon|\n\n`README in English <#cpanel-command-line-interface>`_\n\nUna interfaz de l\u00ednea de comandos para la Unrestricted API de cPanel.\n\nEjecute comandos r\u00e1pidamente en una terminal para gestionar un sitio web,\nevitando la necesidad de iniciar sesi\u00f3n en `cPanel`_ y navegar por su interfaz\nweb. Esta utilidad tambi\u00e9n se puede integrar sin problemas en tareas de scripting.\n\nSe implementa una parte de la UAPI (API sin restricciones) de cPanel, lo que\nle permite realizar una amplia gama de funciones con facilidad.\n\nAlgunos ejemplos:\n\n- Crear una copia de seguridad de la cuenta y almacenarla en el directorio home del usuario remoto:\n\n .. code:: sh\n\n $ cpanel create backup home scott@example.com\n\n- Escribir directamente archivos en el directorio home del usuario remoto:\n\n .. code:: sh\n\n $ cpanel write file public_html/index.txt \"Hallo\\nTsch\u00fcss\\n\"\n\n- Crear un nuevo usuario FTP con una cuota y un directorio personal:\n\n .. code:: sh\n\n $ cpanel create ftp bill@example.com 'password' 1024 my_ftp\n\n- Crear una respuesta autom\u00e1tica de correo electr\u00f3nico:\n\n .. code:: sh\n\n $ cpanel set mail autoresponder \\\n scott@example.com \\\n \"Bruce Scott\" \\\n \"Este es mensaje autom\u00e1tico\" \\\n \"No estoy disponible por el momento, por favor contacte a mi jefe.\" \\\n \"Tomorrow 6 PM\" \\\n \"December 15, 8:00 AM\"\n\n- Cambiar a franc\u00e9s el idioma de la interfaz de usuario de cPanel:\n\n .. code:: sh\n\n $ cpanel set locale fr\n\n- Listar las caracter\u00edsticas disponibles de cPanel:\n\n .. code:: sh\n\n $ cpanel list features\n\n {\n \"addoncgi\": 0,\n \"addondomains\": 1,\n \"agora\": 1,\n . . .\n \"webmail\": 1,\n \"webprotect\": 1,\n \"zoneedit\": 1\n }\n\n- Listar las cuentas de correo electr\u00f3nico de cPanel:\n\n .. code:: sh\n\n $ cpanel list mail accounts\n\n [\n {\n \"email\": \"scott@example.com\",\n . . .\n }\n ]\n\n\nY muchas cosas m\u00e1s. Con el tiempo espero cubrir completamente las m\u00e1s de 500\nfunciones disponibles en el API.\n\nLa salida es JSON, por lo que es f\u00e1cilmente analizable utilizando\nun `procesador CLI de JSON, como por ejemplo jq`_\n\n.. _`procesador CLI de JSON, como por ejemplo jq`: https://stedolan.github.io/jq/\n\nConsulte la `Gu\u00eda`_ del usuario para una referencia completa de las\nfunciones implementadas de la API.\n\n.. _`Gu\u00eda`: https://cpanel-cli.readthedocs.io/es/stable/\n\nGu\u00eda r\u00e1pida\n===========\n\n**cpanel-cli** funciona en Linux y macOS (podr\u00eda funcionar `en Windows`_) y\nrequiere Python 3.11 o posterior.\n\nPara Linux, instale Python 3.11 o posterior utilizando el gestor de paquetes\nde su distro.\n\nPara macOS, instale Python 3.11 o posterior usando Homebrew_.\n\n.. _`en Windows`: #se-puede-usar-en-windows\n\nCree un archivo ``.cpanelrc`` en su directorio ``$HOME`` con el siguiente contenido:\n\n .. code:: sh\n\n hostname=example.com\n username=scott\n utoken=ABCDEFGHIJKLMNOPQSRTUVWXYZ012345\n\n- ``hostname`` es el nombre de host su instancia de cPanel\n- ``username`` es su nombre de usuario en la instancia\n- ``utoken`` es un token API asociado con el ``username``. Lea `c\u00f3mo crear un token API`_.\n\n.. _`c\u00f3mo crear un token API`: https://docs.cpanel.net/knowledge-base/security/how-to-use-cpanel-api-tokens/#create-an-api-token\n\nA continuaci\u00f3n, ejecute:\n\n.. code:: sh\n\n $ python3 -m pip install --user cpanel-cli\n\n\nPruebe la instalaci\u00f3n:\n\n.. code:: sh\n\n $ cpanel --version\n\nGu\u00eda del usuario\n================\n\nConsulte la Gu\u00eda del usuario en https://cpanel-cli.readthedocs.io/es/stable/\npara instrucciones detalladas de instalaci\u00f3n y configuraci\u00f3n, as\u00ed\ncomo una referencia completa de las funciones implementadas del API.\n\n\nC\u00f3mo contribuir\n===============\n\nLos pull requests son m\u00e1s que bienvenidos. Consulte `CONTRIBUTING en espa\u00f1ol`_\npara una gu\u00eda detallada de c\u00f3mo colaborar con este proyecto.\n\n.. _`CONTRIBUTING en espa\u00f1ol`: https://github.com/layfellow/cpanel-cli/blob/main/CONTRIBUTING.rst#como-contribuir\n\n\u00bfSe puede usar en Windows?\n==========================\n\n**cpanel-cli** deber\u00eda funcionar en Windows 10/11 v\u00eda `WSL 2`_ (Windows Subsystem for Linux).\n\nDesafortunadamente no tengo acceso a un sistema Windows, as\u00ed que no puedo confirmarlo.\n",
"bugtrack_url": null,
"license": "GNU General Public License v3 (GPLv3)",
"summary": "A command line interface for the cPanel Unrestricted API.",
"version": "0.29",
"project_urls": {
"Bug Tracker": "https://github.com/layfellow/cpanel-cli/issues",
"Documentation": "https://cpanel-cli.readthedocs.io/",
"Homepage": "https://github.com/layfellow/cpanel-cli",
"Repository": "https://github.com/layfellow/cpanel-cli"
},
"split_keywords": [
"cli",
" command-line",
" cpanel",
" hosting"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0e1743a6d317150945a80f3f2be422dbe6e091d4f7c62684b25cbd910581ebde",
"md5": "3cd1667fbb96fada6955e58f08d76f6a",
"sha256": "50d12d4a851b2d7e2528544b0f31e5fe2dad420948493c0eae193d03b2935782"
},
"downloads": -1,
"filename": "cpanel_cli-0.29-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3cd1667fbb96fada6955e58f08d76f6a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 60308,
"upload_time": "2024-12-01T23:56:22",
"upload_time_iso_8601": "2024-12-01T23:56:22.722950Z",
"url": "https://files.pythonhosted.org/packages/0e/17/43a6d317150945a80f3f2be422dbe6e091d4f7c62684b25cbd910581ebde/cpanel_cli-0.29-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7bcf9ba27c82503aaa4660a44522d55201d791ab23ffffa9d882dbca8b414be7",
"md5": "98abffce8c33a203f2782f7957f55c5b",
"sha256": "d0cbf08f8dc472dd5c2753085c50b87e2c74e8e945100b4d2df93d31ae745ddf"
},
"downloads": -1,
"filename": "cpanel_cli-0.29.tar.gz",
"has_sig": false,
"md5_digest": "98abffce8c33a203f2782f7957f55c5b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 122602,
"upload_time": "2024-12-01T23:56:25",
"upload_time_iso_8601": "2024-12-01T23:56:25.185380Z",
"url": "https://files.pythonhosted.org/packages/7b/cf/9ba27c82503aaa4660a44522d55201d791ab23ffffa9d882dbca8b414be7/cpanel_cli-0.29.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-01 23:56:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "layfellow",
"github_project": "cpanel-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "cpanel-cli"
}
JSON
