Puedes habilitar la función de autocompletado para los comandos de la CLI de MongoDB para ver los comandos disponibles y su sintaxis directamente en tu shell.
Habilita la función de autocompletar
Si instalaste la CLI de MongoDB con Homebrew, la funcionalidad de autocompletado está incluida con la instalación. Debes configurar tu shell para habilitar su soporte de finalización. Para habilitar el autocompletado en tu shell, consulta la Documentación de Homebrew.
Si no instalaste la CLI de MongoDB con Homebrew, el procedimiento para habilitar el autocompletado depende del shell en el que ejecutes la CLI de MongoDB.
Z Shell
Si usas zsh para ejecutar la CLI de MongoDB, ejecuta el siguiente comando para activar la función de autocompletado en tu shell actual:
echo "autoload -U compinit; compinit" >> ~/.zshrc
Para habilitar el autocompletado para todas las futuras sesiones de la shell:
Si usas MacOS, ejecuta el siguiente comando:
mongocli completion zsh > /usr/local/share/zsh/site-functions/_mongocli Si utilizas Linux, ejecuta el siguiente comando:
mongocli completion zsh > "${fpath[1]}/_mongocli"
Inicie un nuevo shell para que la configuración surta efecto.
Bash
Si utilizas Bash para ejecutar la CLI de MongoDB, instala el paquete bash-completion mediante el administrador de paquetes de tu sistema operativo. Luego, ejecuta el siguiente comando para habilitar la autocompletar en tu shell actual:
source <(mongocli completion bash)
Para habilitar el autocompletado para todas las futuras sesiones de la shell:
Si usas MacOS, ejecuta el siguiente comando:
mongocli completion bash > /usr/local/etc/bash_completion.d/mongocli Si utilizas Linux, ejecuta el siguiente comando:
mongocli completion bash > /etc/bash_completion.d/mongocli
Inicie un nuevo shell para que la configuración surta efecto.
Pescado
Si usas fish para ejecutar la CLI de MongoDB, ejecuta el siguiente comando para activar la función de autocompletado en tu shell actual:
mongocli completion fish | source
Para habilitar el autocompletado para todas las futuras sesiones de la shell:
Ejecuta el siguiente comando:
mongocli completion fish > ~/.config/fish/completions/mongocli.fish Inicie un nuevo shell para que la configuración surta efecto.
PowerShell
Si utilizas PowerShell para ejecutar la MongoDB CLI, ejecuta el siguiente comando para habilitar el autocompletado en tu shell actual:
PS C:\> mongocli completion powershell | Out-String | Invoke-Expression
Para habilitar el autocompletado para todas las futuras shells, agrega la salida del comando anterior a tu perfil de PowerShell. Para aprender a editar un perfil de PowerShell, consulta Documentación de Windows.
Usa Tab para autocompletar comandos
Una vez que se haya configurado la función de autocompletar, podrá autocompletar comandos escribiendo mongocli en la shell y presionando la tecla Tab. Presiona Tab varias veces para alternar entre las opciones de autocompletar disponibles.
Puedes presionar Tab en cualquier etapa de la redacción de tu comando para ver las opciones de autocompletado disponibles.
Ejemplos
Cuando escribes mongocli en tu shell y presionas Tab, la salida se muestra así:
atlas -- Atlas operations. cloud-manager -- Cloud Manager operations. completion -- Generate shell completion scripts config -- Configure a profile to store access settings for your MongoDB deployment. help -- Help about any command iam -- Organization and projects operations. ops-manager -- Ops Manager operations.
Si escribes una propiedad específica como atlas como parte de tu comando, puedes ver opciones de autocompletado para la propiedad seleccionada.
Por ejemplo, cuando escribes mongocli atlas en tu shell y presionas Tab, la salida se parece a lo siguiente:
accessLists -- Manage the IP access list for your project. accessLogs -- Manage the access logs of a cluster. alerts -- Manage alerts for your project. backups -- Manage backups for your project. clusters -- Manage clusters for your project. dbusers -- Manage database users for your project. events -- Manage events for your project. logs -- Download host logs for your project. metrics -- Get measurements on the state of the MongoDB process. processes -- Manage MongoDB processes for your project.