Uso del sistema de ayuda para detectar un comando
Puede obtener más información sobre un comando específico mediante el sistema de ayuda integrado de PowerShell. Use el cmdlet Get-Command para buscar un comando que necesite. Llegado a este punto, es posible que quiera saber más sobre lo que hace el comando y varias formas de llamarlo.
Detección de cmdlets con el sistema de ayuda y Get-Help
Puede usar el cmdlet principal Get-Help para obtener más información sobre un comando. Por lo general, para invocar Get-Help se especifica su nombre y se agrega la marca -Name que contiene el nombre del cmdlet del que se quiere obtener información. Este es un ejemplo:
Get-Help -Name Get-Help
Actualización de la ayuda
Las nuevas versiones de PowerShell no incluyen el sistema de ayuda de forma predeterminada. La primera vez que se ejecuta Get-Help, se le pedirá que instale los archivos de ayuda. También puede ejecutar el cmdlet Update-Help para instalar los archivos de ayuda. Como una llamada a Update-Help descarga muchos archivos de ayuda, de forma predeterminada el comando solo puede realizar la captura una vez al día. Puede invalidar este comportamiento de captura si usa la marca -Force.
Los archivos de ayuda se actualizan de forma diferente en Windows en comparación con Linux o macOS. El proceso es diferente porque al ejecutar el cmdlet Update-Help, los archivos de ayuda se obtienen mediante Internet haciendo coincidir la referencia cultural del equipo. En Windows, ya hay una referencia cultural instalada, pero no en Linux y macOS. Por tanto, debe especificar una referencia cultural al actualizar los archivos de ayuda en Linux y macOS.
Este es un comando de ejemplo:
Update-Help -UICulture en-US -Verbose
Este comando especifica la marca -UICulture. Le asigna el valor en-US, que captura los archivos de ayuda en inglés de EE. UU. Para actualizar los archivos de ayuda en macOS o Linux, use una referencia cultural que se corresponda con la del equipo.
Exploración de las secciones de la ayuda
Al invocar Get-Help en un cmdlet, se devuelve una página de ayuda. La página incluye muchas secciones. Es probable que vea estas secciones comunes:
- NAME: proporciona el nombre del comando.
- SYNTAX: muestra las maneras de llamar al comando mediante una combinación de marcas y, en ocasiones, parámetros permitidos.
- ALIASES: enumera los alias de un comando. Un alias es otro nombre para un comando y se puede usar para invocarlo.
- REMARKS: proporciona información sobre los comandos que se ejecutan para obtener más ayuda para este comando.
- PARAMETERS: proporciona detalles sobre el parámetro. Se muestra su tipo, una descripción más larga y los valores que acepta, si procede.
Filtrado de la respuesta de la ayuda
Si no quiere mostrar la página de ayuda completa, puede limitar la respuesta mediante la incorporación de marcas al comando Get-Help. Estas son algunas marcas que puede usar:
- Full: devuelve una página de ayuda detallada. Especifica información como parámetros, entradas y salidas que no se obtienen en la respuesta estándar.
- Detailed: devuelve una respuesta similar a la respuesta estándar, pero incluye una sección para los parámetros.
- Examples: devuelve solo ejemplos, si existen.
- Online: abre una página web para el comando.
- Parameter: necesita un nombre de parámetro como argumento. Enumera las propiedades de un parámetro específico.
Por ejemplo, puede usar el comando siguiente para devolver solo la sección Examples (Ejemplos) de la página de ayuda.
Get-Help Get-FileHash -Examples
Mejora de la experiencia de lectura
La ejecución de Get-Help devuelve la página de ayuda completa. Es posible que la página no proporcione la mejor experiencia de lectura. Puede que tenga que desplazarse para encontrar la sección que desea leer. Un enfoque mejor consiste en usar el alias help. El alias help canaliza Get-Help en una función que garantiza que la salida sea legible línea a línea. También hace que la respuesta se pueda leer página por página, al paginar la salida. Usará el alias help en la unidad siguiente.