mcfly

Buscando co-mantenedores : No tengo mucho tiempo para mantener este proyecto en estos días. Si alguien quisiera participar y convertirse en co-mantenedor, ¡se lo agradeceríamos!

McFly: vuela por el historial de tu caparazón

McFly reemplaza su búsqueda predeterminada en el historial del shell ctrl-r con un motor de búsqueda inteligente que tiene en cuenta su directorio de trabajo y el contexto de los comandos ejecutados recientemente. Las sugerencias de McFly se priorizan en tiempo real con una pequeña red neuronal.

TL;DR: un ctrl-r actualizado donde los resultados del historial tienen sentido para lo que estás trabajando en este momento.

Características

• Vuelve a vincular ctrl-r para mostrar una búsqueda de historial inverso en pantalla completa priorizada con una pequeña red neuronal.
• Aumenta su historial de shell para rastrear el estado de salida del comando, la marca de tiempo y el directorio de ejecución en una base de datos SQLite.
• También mantiene su archivo de historial de shell normal para que pueda dejar de usar McFly cuando lo desee.
• Soporte Unicode en todo momento.
• Incluye una acción simple para eliminar cualquier elemento del historial de la base de datos de McFly y de los archivos del historial del shell.
• Diseñado para ser extensible a otros proyectiles en el futuro.
• Escrito en Rust, por lo que es rápido y seguro.
• Puede escribir % para que coincida con cualquier número de caracteres al realizar la búsqueda.

Priorización

La característica clave de McFly es la priorización de comandos inteligente impulsada por una pequeña red neuronal que se ejecuta en tiempo real. El objetivo es que el comando que desea ejecutar sea siempre una de las principales sugerencias.

Al sugerir un comando, McFly tiene en cuenta:

• El directorio donde ejecutó el comando. Es probable que ejecute ese comando en el mismo directorio en el futuro.
• Qué comandos escribió antes del comando (por ejemplo, el contexto de ejecución del comando).
• Con qué frecuencia ejecuta el comando.
• La última vez que ejecutó el comando.
• Si ha seleccionado el comando en McFly antes.
• El estado de salida histórico del comando. Probablemente no quieras ejecutar comandos antiguos fallidos.

Instalación

Instalar con Homebrew (en macOS o Linux)

1. Instalar mcfly :

   brew install mcfly

2. Agregue lo siguiente al final de su archivo ~/.bashrc , ~/.zshrc o ~/.config/fish/config.fish :

   Intento:

    eval " $( mcfly init bash ) "

   Zsh:

    eval " $( mcfly init zsh ) "

   Pez:

   mcfly init fish | source

3. Correr . ~/.bashrc / . ~/.zshrc / source ~/.config/fish/config.fish o reinicie su emulador de terminal.

Desinstalar con Homebrew

1. Quitar mcfly :

   brew uninstall mcfly

2. Elimine las líneas que agregó a ~/.bashrc / ~/.zshrc / ~/.config/fish/config.fish .

Instalar con MacPorts (en macOS)

1. Actualizar el árbol de puertos

   sudo port selfupdate

2. Instalar mcfly :

   sudo port install mcfly

3. Agregue lo siguiente al final de su archivo ~/.bashrc , ~/.zshrc o ~/.config/fish/config.fish , según corresponda:

   Intento:

    eval " $( mcfly init bash ) "

   Zsh:

    eval " $( mcfly init zsh ) "

   Pez:

   mcfly init fish | source

4. Correr . ~/.bashrc / . ~/.zshrc / source ~/.config/fish/config.fish o reinicie su emulador de terminal.

Desinstalación con MacPorts

1. Quitar mcfly :

   sudo port uninstall mcfly

2. Elimine las líneas que agregó a ~/.bashrc / ~/.zshrc / ~/.config/fish/config.fish .

Instalación usando nuestro script de instalación (macOS o Linux)

1. curl -LSfs https://raw.githubusercontent.com/cantino/mcfly/master/ci/install.sh | sh -s -- --git cantino/mcfly (o, si el usuario actual no tiene permisos para editar /usr/local/bin, utilice sudo sh -s ).

2. Agregue lo siguiente al final de su archivo ~/.bashrc , ~/.zshrc o ~/.config/fish/config.fish , respectivamente:

   Intento:

    eval " $( mcfly init bash ) "

   Zsh:

    eval " $( mcfly init zsh ) "

   Pez:

   mcfly init fish | source

3. Correr . ~/.bashrc / . ~/.zshrc / source ~/.config/fish/config.fish o reinicie su emulador de terminal.

Instalación manual desde GitHub (macOS o Linux)

1. Descargue la última versión de GitHub.

2. Instálelo en una ubicación en su $PATH . (Por ejemplo, puede crear un directorio en ~/bin , copiar mcfly a esta ubicación y agregar export PATH="$PATH:$HOME/bin" a su .bashrc / .zshrc o ejecutar set -Ua fish_user_paths "$HOME/bin" para pescado.)

3. Agregue lo siguiente al final de su ~/.bashrc , ~/.zshrc o ~/.config/fish/config.fish , respectivamente:

   Intento:

    eval " $( mcfly init bash ) "

   Zsh:

    eval " $( mcfly init zsh ) "

   Pez:

   mcfly init fish | source

4. Correr . ~/.bashrc / . ~/.zshrc / source ~/.config/fish/config.fish o reinicie su emulador de terminal.

Instalar manualmente desde la fuente (macOS, Linux o Windows)

1. Instale Rust 1.40 o posterior

2. Ejecute git clone https://github.com/cantino/mcfly y cd mcfly

3. Ejecute cargo install --path .

4. Asegúrese de ~/.cargo/bin esté en su $PATH .

5. Agregue lo siguiente al final de su ~/.bashrc , ~/.zshrc , ~/.config/fish/config.fish o powershell $PROFILE , respectivamente:

   Intento:

    eval " $( mcfly init bash ) "

   Zsh:

    eval " $( mcfly init zsh ) "

   Pez:

   mcfly init fish | source

   Núcleo Powershell (pwsh)

    Invoke-Expression - Command $ (mcfly init powershell | out-string )

6. Correr . ~/.bashrc / . ~/.zshrc / source ~/.config/fish/config.fish / . $PROFILE o reinicia tu emulador de terminal.

Instalar por Zinit

• Agregue el siguiente código a su zshrc.

  zinit ice lucid wait " 0a " from " gh-r " as " program " atload ' eval "$(mcfly init zsh)" '
  zinit light cantino/mcfly

• Descargará mcfly y lo instalará por usted.

• $(mcfly init zsh) se ejecutará después del aviso

iTerm2

Para evitar que la interfaz de usuario de McFly arruine su historial de desplazamiento hacia atrás en iTerm2, asegúrese de que esta opción no esté marcada:

Historial de volcado

McFly puede volcar el historial de comandos en stdout .

Por ejemplo:

mcfly dump --since ' 2023-01-01 ' --before ' 2023-09-12 09:15:30 '

volcará el comando ejecutado entre 2023-01-01 00:00:00.0 y 2023-09-12 09:15:30 ( exclusivo ) como json . También puede especificar csv como formato de volcado mediante --format csv .

Cada elemento de los comandos volcados tiene los siguientes campos:

• cmd : el comando de ejecución.
• when_run : la hora a la que se ejecutó el comando en su zona horaria local.

Puedes volcar todo el historial de comandos sin ningún argumento:

mcfly dump

Formato de marca de tiempo

McFly analiza las marcas de tiempo mediante chrono-systemd-time , una implementación no estricta de systemd.time, con las siguientes excepciones:

• Las unidades de tiempo deben acompañar a todos los valores de intervalo de tiempo.
• No se admiten sufijos de zona horaria.
• Los prefijos de días laborables no son compatibles.

Los usuarios de McFly simplemente deben comprender que no está permitido especificar la zona horaria en la marca de tiempo . McFly siempre utilizará su zona horaria local .

Para obtener más detalles, consulte la documentación chrono-systemd-time .

expresión regular

Dump admite comandos de filtrado con expresiones regulares. La sintaxis de expresiones regulares sigue la expresión regular de caja.

Por ejemplo:

mcfly dump -r ' ^cargo run '

volcará todos los prefijos de comando con cargo run .

Puede usar las opciones -r/--regex y hora al mismo tiempo.

Por ejemplo:

mcfly dump -r ' ^cargo run ' --since ' 2023-09-12 09:15:30 '

volcará todos los prefijos de comando con cargo run ejecutado desde 2023-09-12 09:15:30 .

Ajustes

Se pueden establecer varias configuraciones a través de variables de entorno. Para establecer una configuración, debe agregar los siguientes fragmentos a su ~/.bashrc / ~/.zshrc / ~/.config/fish/config.fish .

Modo de luz

Para cambiar el esquema de color para usarlo en una terminal ligera, configure la variable de entorno MCFLY_LIGHT .

bash/zsh:

 export MCFLY_LIGHT=TRUE

pez:

 set -gx MCFLY_LIGHT TRUE

powershell:

 $ env: MCFLY_LIGHT = " TRUE "

Consejo: en macOS puedes usar el siguiente fragmento para configurar la combinación de colores según la configuración de todo el sistema:

bash/zsh:

 if [[ " $( defaults read -g AppleInterfaceStyle 2 & > /dev/null ) " != " Dark " ]] ; then
    export MCFLY_LIGHT=TRUE
fi

Esquema de claves VIM

De forma predeterminada, Mcfly utiliza un esquema de claves inspirado emacs . Si desea cambiar al esquema de claves inspirado vim , configure la variable de entorno MCFLY_KEY_SCHEME .

bash/zsh:

 export MCFLY_KEY_SCHEME=vim

pez:

 set -gx MCFLY_KEY_SCHEME vim

powershell:

 $ env: MCFLY_KEY_SCHEME = " vim "

Búsqueda difusa

Para habilitar la búsqueda difusa, establezca MCFLY_FUZZY en un número entero. 0 está apagado; Los números más altos pesan hacia partidos más cortos. Los valores en el rango de 2 a 5 obtienen buenos resultados hasta el momento; ¡Pruebe algunos e informe cuál funciona mejor para usted!

bash/zsh:

 export MCFLY_FUZZY=2

pez:

 set -gx MCFLY_FUZZY 2

powershell:

 $ env: MCFLY_FUZZY = 2

Recuento de resultados

Para cambiar el número máximo de resultados mostrados, configure MCFLY_RESULTS (predeterminado: 10).

bash/zsh:

 export MCFLY_RESULTS=50

pez:

 set -gx MCFLY_RESULTS 50

powershell:

 $ env: MCFLY_RESULTS = 50

Eliminar sin confirmación

Para eliminar sin confirmación, establezca MCFLY_DELETE_WITHOUT_CONFIRM en verdadero.

bash/zsh:

 export MCFLY_DELETE_WITHOUT_CONFIRM=true

pez:

 set -gx MCFLY_DELETE_WITHOUT_CONFIRM true

powershell:

 $ env: MCFLY_DELETE_WITHOUT_CONFIRM = " true "

Vista de interfaz

Para cambiar la vista de la interfaz, configure MCFLY_INTERFACE_VIEW (predeterminado: TOP ). Opciones disponibles: TOP y BOTTOM

bash/zsh:

 export MCFLY_INTERFACE_VIEW=BOTTOM

pez:

 set -gx MCFLY_INTERFACE_VIEW BOTTOM

powershell:

 $ env: MCFLY_INTERFACE_VIEW = " BOTTOM "

Deshabilitar la interfaz del menú

Para deshabilitar la interfaz del menú, configure la variable de entorno MCFLY_DISABLE_MENU .

bash/zsh:

 export MCFLY_DISABLE_MENU=TRUE

pez:

 set -gx MCFLY_DISABLE_MENU TRUE

powershell:

 $ env: MCFLY_DISABLE_MENU = true

Clasificación de resultados

Para cambiar la clasificación de los resultados mostrados, configure MCFLY_RESULTS_SORT (predeterminado: RANK). Valores posibles RANK y LAST_RUN

bash/zsh:

 export MCFLY_RESULTS_SORT=LAST_RUN

pez:

 set -gx MCFLY_RESULTS_SORT LAST_RUN

powershell:

 $ env: MCFLY_RESULTS_SORT = " LAST_RUN "

Mensaje personalizado

Para cambiar el mensaje, configure MCFLY_PROMPT (predeterminado: $ ).

bash/zsh:

 export MCFLY_PROMPT= " ❯ "

pez:

 set -gx MCFLY_PROMPT " ❯ "

powershell:

 $ env: MCFLY_PROMPT = " > "

Tenga en cuenta que sólo se permiten mensajes de un solo carácter. configurar MCFLY_PROMPT en "<str>" lo restablecerá al mensaje predeterminado.

Ubicación de la base de datos

McFly almacena su base de datos SQLite en la ubicación estándar del sistema operativo. En OS X, esto está en ~/Library/Application Support/McFly , en Linux está en $XDG_DATA_DIR/mcfly/history.db (el valor predeterminado sería ~/.local/share/mcfly/history.db ) y en Windows , es %LOCALAPPDATA%McFlydatahistory.db . Para soporte heredado, si ~/.mcfly/ existe, se usa en su lugar.

Inicio lento

Si tiene una base de datos histórica muy grande y nota que McFly se inicia lentamente, puede configurar MCFLY_HISTORY_LIMIT en algo así como 10000 para limitar la cantidad de registros que se consideran al realizar la búsqueda. En este ejemplo, McFly buscaría sólo las 10.000 entradas más recientes.

Bash TIOCSTI

A partir de la versión 6.2 del kernel de Linux, algunos sistemas han desactivado TIOCSTI (que McFly usaba anteriormente para escribir el comando seleccionado). McFly soluciona este problema utilizando dos combinaciones de teclas "ficticias", que de forma predeterminada son ctrl-x 1 y ctrl-x 2 . Si está utilizando cualquiera de estos para otro propósito, puede configurar MCFLY_BASH_SEARCH_KEYBINDING y MCFLY_BASH_ACCEPT_LINE_KEYBINDING , respectivamente, en algo que no esté utilizando. Si prefiere utilizar el comportamiento TIOCSTI heredado, puede habilitarlo configurando la variable sysctl dev.tty.legacy_tiocsti en 1 en su sistema y configurando la variable bash MCFLY_BASH_USE_TIOCSTI en 1 .

HISTTIMEFORMAT

McFly actualmente no analiza ni usa HISTTIMEFORMAT .

Posibles características futuras

• Agregue un screencast a README.
• ¿Aprender opciones de comando comunes y completarlas automáticamente en la interfaz de usuario de sugerencias?
• Ordene los argumentos de la línea de comando cuando encuentre la cadena coincidente con la plantilla.
• Posibles mejoras en la priorización:
  • Validación cruzada y selección de conjuntos de entrenamiento explícito.
  • Aprenda las incrustaciones de comandos

Desarrollo

Contribuyendo

¡Se recomiendan contribuciones y correcciones de errores! Sin embargo, no podemos fusionar RP que aumenten significativamente la complejidad más allá de lo que ya se requiere para mantener el proyecto. Si tiene dudas, no dude en abrir un problema y preguntar.

Ejecución de pruebas

cargo test

Lanzamiento (notas para @cantino)

1. Edite Cargo.toml y aumente la versión.
2. Editar CAMBIO.txt
3. Ejecute cargo clippy y cargo fmt .
4. Recompilar ( cargo build ) y probar ( cargo test )
5. git add -p
6. git ci -m 'Bumping to vx.x.x'
7. git tag vx.xx
8. git push origin head --tags
9. Deja que la construcción termine.
10. Edite la nueva versión en Github.
11. cargo publish
12. TBD: actualice la fórmula homebrew-core en https://github.com/Homebrew/homebrew-core/blob/master/Formula/m/mcfly.rb

Viejo:

1. Edite pkg/brew/mcfly.rb y actualice la versión y los SHA. ( shasum -a 256 ... )
2. Edite ../homebrew-mcfly/pkg/brew/mcfly.rb también.
3. cp pkg/brew/mcfly.rb ../homebrew-mcfly/pkg/brew/mcfly.rb
4. Comparar con diff ../homebrew-mcfly/pkg/brew/mcfly.rb ../mcfly/pkg/brew/mcfly.rb ; diff ../homebrew-mcfly/HomebrewFormula/mcfly.rb ../mcfly/HomebrewFormula/mcfly.rb
5. git add -p && git ci -m 'Update homebrew' && git push
6. cd ../homebrew-mcfly && git add -p && git ci -m 'Update homebrew' && git push && cd ../mcfly