Cheat.sh, documentación para la línea de comandos o para tu editor

about cheat.sh

En el siguiente artículo vamos a echar un vistazo a cheat.sh. Este script nos va a proporcionar acceso a documentación y fragmentos de código dirigidos por la comunidad, para los comandos de Linux / UNIX y muchos lenguajes de programación. Este proyecto no es nuevo, comenzó su andadura en 2017, pero sigue resultando muy útil para muchos usuarios.

Para mostrar su contenido, la herramienta hace uso de fuentes impulsadas por la comunidad como páginas TLDR, StackOverflow y otros, así como su propio repositorio. Vamos a poder utilizar esta utilidad desde el navegador web, la línea de comandos o como un complemento para Vim, Emacs o Sublime Text, entre otros editores.

Esta herramienta ha sido desarrollada por Igor Chubin, también conocido por su servicio orientado a la consola para el pronóstico del tiempo llamado wttr.in.

Características generales de Cheat.sh

  • Podremos hacer consultas sobre 58 lenguajes de programación, varios DBMS y 1000 de los comandos UNIX/Linux más importantes.
  • Un cliente para la línea comandos opcional (cht.sh ) está disponible. Este nos va a permitir realizar búsquedas rápidamente y copiar fragmentos de código fácilmente sin salir de la terminal.
  • Las interfaces web y cht.sh (línea de comando) utilizan cheat.sh, pero si el usuario lo prefiere, puede auto hospedarlo.
  • El cliente de línea de comandos presenta un modo de shell especial con un contexto de consultas persistentes. También tiene un historial de consultas que se integra con el portapapeles. Al tiempo admite la finalización de pestañas para shells como Bash, Fish y Zsh.
  • Ofrece resultados muy rápido. Devuelve respuestas en menos de 100 ms.
  • La utilidad podremos utilizarla desde editores de código. Esto nos va a permitir insertar fragmentos de código sin tener que abrir un navegador web, buscar el código, copiarlo y luego volver al editor de código para pegarlo. Es compatible con Vim, Emacs, Visual Studio Code, Sublime Text e IntelliJ Idea.

Si alguien se anima, puede contribuir al proyecto. Se puede consultar la guía cheat.sh para editar o agregar contenido.

Cómo instalar el cliente de línea de comandos cht.sh

Vamos a poder utilizar cheat.sh en un navegador web, desde la línea de comandos con la ayuda de curl sin tener que instalar nada más, como un complemento de editor de código o utilizando su cliente de línea de comandos.

Si quieres instalarlo como un complemento de algún editor de código, se puede consultar la página para la integración en editores.

A continuación vamos a ver los pasos necesarios para instalar este cliente de línea de comandos llamado cht.sh, pero antes habrá que solucionar el tema de las dependencias.

Instalar dependencias

Para poder instalar el cliente de línea de comandos cht.sh, utilizaremos curl. Otra dependencia es rlwrap, que es requerida por el modo de shell especial cht.sh. En Debian, Ubuntu, Linux Mint y cualquier otra distribución Gnu/Linux basada en Debian o Ubuntu, escribiremos en la terminal (Ctrl+Alt+T):

instalar dependencias

sudo apt install curl rlwrap

Descargar e instalar la interfaz de línea de comandos cht.sh

Podremos instalarlo solo para un usuario o para todos los usuarios. Puedes instalarlo para todos los usuarios utilizando la carpeta /usr/local/bin:

cht.sh curl

curl https://cht.sh/:cht.sh | sudo tee /usr/local/bin/cht.sh

sudo chmod +x /usr/local/bin/cht.sh

Si el primer comando parece haberse congelado y muestra solo la salida de CURL, pulsa la tecla Intro. Te pedirá que escribas tu contraseña para guardar el archivo en /usr/local/bin.

Si quieres instalarlo solo para tu usuario asumiremos que tienes una carpeta ~/.bin agregada a tu PATH y la carpeta existe. Esta carpeta la puedes cambiar a tu gusto. Según donde quieras instalar cht.sh, cambia la ruta de instalación en los comandos:

curl https://cht.sh/:cht.sh > ~/.bin/cht.sh

chmod +x ~/.bin/cht.sh

Ejemplos de uso del cliente

A continuación vamos a ver algunos ejemplos de uso de cheat.sh usando curl desde la línea de comandos:

Para mostrar los algunas opciones disponibles para el comando ls:

cheat.sh ls

curl cheat.sh/ls

Cht.sh también funciona en lugar de cheat.sh:

cht.sh ls

curl cht.sh/ls

Para ver un ejemplo de la función rand() para el lenguaje de programación PHP escribiremos:

función rand php

curl cht.sh/php/rand

Si quieres eliminar los comentarios que van a verse en el resultado habrá que añadir ?Q al final de la consulta:

rand php sin comentarios

curl cht.sh/php/rand?Q

Vamos a poder iniciar el cliente cht.sh en un modo de shell especial usando:

cht.sh --shell

cht.sh --shell

Después podremos comenzar a escribir nuestras consultas. Para cerrar, solo hay que escribir exit.

cht --help

Si escribimos help en el modo shell interactivo cht.sh, podremos para ver todas las posibilidades disponibles. También se puede buscar en la sección Uso de la página del proyecto cheat.sh en GitHub para consultar las opciones que nos ofrece.


Sé el primero en comentar

Deja tu comentario

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *

*

*

  1. Responsable de los datos: Miguel Ángel Gatón
  2. Finalidad de los datos: Controlar el SPAM, gestión de comentarios.
  3. Legitimación: Tu consentimiento
  4. Comunicación de los datos: No se comunicarán los datos a terceros salvo por obligación legal.
  5. Almacenamiento de los datos: Base de datos alojada en Occentus Networks (UE)
  6. Derechos: En cualquier momento puedes limitar, recuperar y borrar tu información.