No hay cmdlets más familiares tanto para los recién llegados como para los expertos que el Comando de Ayuda de PowerShell, Get-Help. Debido al sistema integrado y actualizable de ayuda de PowerShell, el comando Get-Help de PowerShell es la forma en que descubres qué hacen los comandos, sus parámetros e incluso (con suerte) montones de ejemplos útiles sobre cómo usar el comando.
Cada cmdlet y función que encuentres se supone que tiene contenido de ayuda integrado que el cmdlet Get-Help de PowerShell puede leer. Digo “se supone que” porque, desafortunadamente, algunos autores no incluyen contenido de ayuda.
El contenido de ayuda asociado con los comandos se puede encontrar ejecutando Get-Help. Este comando lee tanto la ayuda basada en comentarios como la ayuda basada en XML que es creada por el autor del cmdlet o función.
El uso más común del cmdlet Get-Help es utilizarlo para encontrar contenido de ayuda para un comando en particular. Por ejemplo, quizás hayas descubierto un nuevo comando llamado Get-Content con el cmdlet Get-Command y quieras saber más información al respecto. Utilizarías el parámetro Name en Get-Help. Esto devolvería un conjunto básico de información sobre ese comando, como puedes ver a continuación.
Notarás que aunque se devuelve mucha información, es solo un resumen de las cosas que puedes hacer. Y nunca sabrías que Get-Help también puede devolver otros tipos de contenido de ayuda como ejemplos.
Encontrar información de parámetros
Puedes profundizar en el contenido de ayuda de varias formas diferentes. Una de esas formas es encontrar información sobre un solo parámetro de un comando. Quizás en el ejemplo que estoy usando aquí, veo una referencia a un parámetro Raw y no estoy seguro de qué hace ese parámetro. Puedo usar el parámetro Parameter en Get-Help con el parámetro Name para devolver solo información sobre ese parámetro específico del comando.
PowerShell Get-Help y Ejemplos
Una de las mejores cosas sobre el sistema de ayuda de PowerShell es que tiene soporte nativo para ejemplos. Los ejemplos son una excelente manera de ver, con contexto, cómo usar un comando en particular. Si el autor del comando agregó ejemplos a su contenido de ayuda, puedes ver esos ejemplos usando el parámetro Ejemplos. Cuando usas este parámetro, Get-Help devolverá uno o más ejemplos de cómo se utiliza ese comando en diferentes circunstancias.
Obtener Ayuda Detallada
Los resúmenes, la información de parámetros y los ejemplos no son la única información devuelta por el comando Get-Help de PowerShell. A veces, necesitas ver toda la información disponible para un cmdlet. En ese caso, siempre tienes disponibles los parámetros Detailed y Full. Cada uno de estos parámetros muestra una cantidad creciente de información.
El parámetro Detailed agrega descripciones de parámetros y ejemplos a la pantalla principal de ayuda. En esencia, combinan el uso del parámetro Examples y mostrarán información para todos los parámetros como si hubieras utilizado el parámetro Parameter en todos los parámetros de comando.
Si el parámetro Detailed no es suficiente; siempre puedes optar por el enfoque nuclear y devolver todo el contenido de ayuda con el parámetro Full. Este parámetro no filtra información en absoluto. El parámetro Full lee todo el contenido de ayuda definido para un comando particular.
Obtener Gráfico
Si prefieres una representación más gráfica de la ayuda, también puedes usar el parámetro ShowWindow. Este parámetro abre una ventana que te permite buscar fácilmente el contenido de ayuda y mostrar solo ciertas áreas a través del botón Configuraciones. Esta vista es útil si realmente quieres investigar el contenido de ayuda.
Resumen
Existen algunos otros parámetros menos comunes que puedes utilizar con el comando Get-Help de PowerShell. Si estás interesado en aprender más, ¿sabes cómo encontrar información sobre esos parámetros adicionales, verdad? Sí, Get-Help puede encontrar contenido de ayuda sobre sí mismo.
Utiliza el comando Get-Help religiosamente cuando busques más información sobre comandos de PowerShell. Hay poco motivo para recurrir a Google cuando tienes un sistema de ayuda potente y un comando que te ayuda a aprovecharlo.