mcfly

Procurando co-mantenedores : Não tenho muito tempo para manter este projeto atualmente. Se alguém quiser entrar e se tornar um co-mantenedor, ficaria muito grato!

McFly - voe pelo seu histórico de shell

McFly substitui sua pesquisa de histórico de shell ctrl-r padrão por um mecanismo de pesquisa inteligente que leva em consideração seu diretório de trabalho e o contexto dos comandos executados recentemente. As sugestões do McFly são priorizadas em tempo real com uma pequena rede neural.

DR: um ctrl-r atualizado onde os resultados do histórico fazem sentido para o que você está trabalhando no momento.

Características

• Revincula ctrl-r para exibir uma pesquisa reversa do histórico em tela cheia, priorizada com uma pequena rede neural.
• Aumenta seu histórico de shell para rastrear o status de saída do comando, carimbo de data/hora e diretório de execução em um banco de dados SQLite.
• Mantém também seu arquivo de histórico normal do shell para que você possa parar de usar o McFly sempre que quiser.
• Suporte Unicode por toda parte.
• Inclui uma ação simples para limpar qualquer item do histórico do banco de dados McFly e dos arquivos de histórico do shell.
• Projetado para ser extensível para outros shells no futuro.
• Escrito em Rust, por isso é rápido e seguro.
• Você pode digitar % para corresponder a qualquer número de caracteres durante a pesquisa.

Priorização

A principal característica do McFly é a priorização inteligente de comandos alimentada por uma pequena rede neural que funciona em tempo real. O objetivo é que o comando que você deseja executar seja sempre uma das principais sugestões.

Ao sugerir um comando, o McFly leva em consideração:

• O diretório onde você executou o comando. É provável que você execute esse comando no mesmo diretório no futuro.
• Quais comandos você digitou antes do comando (por exemplo, o contexto de execução do comando).
• Com que frequência você executa o comando.
• Quando você executou o comando pela última vez.
• Se você já selecionou o comando no McFly antes.
• O status histórico de saída do comando. Você provavelmente não deseja executar comandos antigos com falha.

Instalação

Instale com Homebrew (no macOS ou Linux)

1. Instale mcfly :

   brew install mcfly

2. Adicione o seguinte ao final do seu arquivo ~/.bashrc , ~/.zshrc ou ~/.config/fish/config.fish :

   Bash:

    eval " $( mcfly init bash ) "

   Zsh:

    eval " $( mcfly init zsh ) "

   Peixe:

   mcfly init fish | source

3. Correr . ~/.bashrc / . ~/.zshrc / source ~/.config/fish/config.fish ou reinicie seu emulador de terminal.

Desinstalando com Homebrew

1. Remover mcfly :

   brew uninstall mcfly

2. Remova as linhas que você adicionou a ~/.bashrc / ~/.zshrc / ~/.config/fish/config.fish .

Instalar com MacPorts (no macOS)

1. Atualize a árvore de portas

   sudo port selfupdate

2. Instale mcfly :

   sudo port install mcfly

3. Adicione o seguinte ao final do seu arquivo ~/.bashrc , ~/.zshrc ou ~/.config/fish/config.fish , conforme apropriado:

   Bash:

    eval " $( mcfly init bash ) "

   Zsh:

    eval " $( mcfly init zsh ) "

   Peixe:

   mcfly init fish | source

4. Correr . ~/.bashrc / . ~/.zshrc / source ~/.config/fish/config.fish ou reinicie seu emulador de terminal.

Desinstalando com MacPorts

1. Remover mcfly :

   sudo port uninstall mcfly

2. Remova as linhas que você adicionou a ~/.bashrc / ~/.zshrc / ~/.config/fish/config.fish .

Instalando usando nosso script de instalação (macOS ou Linux)

1. curl -LSfs https://raw.githubusercontent.com/cantino/mcfly/master/ci/install.sh | sh -s -- --git cantino/mcfly (ou, se o usuário atual não tiver permissão para editar /usr/local/bin, use sudo sh -s .)

2. Adicione o seguinte ao final do seu arquivo ~/.bashrc , ~/.zshrc ou ~/.config/fish/config.fish , respectivamente:

   Bash:

    eval " $( mcfly init bash ) "

   Zsh:

    eval " $( mcfly init zsh ) "

   Peixe:

   mcfly init fish | source

3. Correr . ~/.bashrc / . ~/.zshrc / source ~/.config/fish/config.fish ou reinicie seu emulador de terminal.

Instalando manualmente do GitHub (macOS ou Linux)

1. Baixe a versão mais recente do GitHub.

2. Instale em um local no seu $PATH . (Por exemplo, você pode criar um diretório em ~/bin , copiar mcfly para este local e adicionar export PATH="$PATH:$HOME/bin" ao seu .bashrc / .zshrc ou executar set -Ua fish_user_paths "$HOME/bin" para peixes.)

3. Adicione o seguinte ao final do seu ~/.bashrc , ~/.zshrc ou ~/.config/fish/config.fish , respectivamente:

   Bash:

    eval " $( mcfly init bash ) "

   Zsh:

    eval " $( mcfly init zsh ) "

   Peixe:

   mcfly init fish | source

4. Correr . ~/.bashrc / . ~/.zshrc / source ~/.config/fish/config.fish ou reinicie seu emulador de terminal.

Instalar manualmente a partir da fonte (macOS, Linux ou Windows)

1. Instale Rust 1.40 ou posterior

2. Execute git clone https://github.com/cantino/mcfly e cd mcfly

3. Execute cargo install --path .

4. Certifique-se de que ~/.cargo/bin esteja em seu $PATH .

5. Adicione o seguinte ao final de seu ~/.bashrc , ~/.zshrc , ~/.config/fish/config.fish ou powershell $PROFILE , respectivamente:

   Bash:

    eval " $( mcfly init bash ) "

   Zsh:

    eval " $( mcfly init zsh ) "

   Peixe:

   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 ou reinicie seu emulador de terminal.

Instalar por Zinit

• Adicione o código abaixo ao seu zshrc.

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

• Ele fará o download do Mcfly e instalará para você.

• $(mcfly init zsh) será executado após prompt

iTerm2

Para evitar que a interface do McFly atrapalhe seu histórico de rolagem no iTerm2, certifique-se de que esta opção esteja desmarcada:

Histórico de despejo

McFly pode despejar o histórico de comandos em stdout .

Por exemplo:

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

irá despejar o comando executado entre 2023-01-01 00:00:00.0 a 2023-09-12 09:15:30 ( exclusivo ) como json . Você também pode especificar csv como formato de despejo via --format csv .

Cada item nos comandos despejados possui os seguintes campos:

• cmd : O comando de execução.
• when_run : a hora em que o comando foi executado em seu fuso horário local.

Você pode despejar todo o histórico de comandos sem nenhum argumento:

mcfly dump

Formato de carimbo de data/hora

McFly analisa carimbos de data/hora por meio de chrono-systemd-time , uma implementação não estrita de systemd.time, com as seguintes exceções:

• as unidades de tempo devem acompanhar todos os valores do intervalo de tempo.
• sufixos de fuso horário não são suportados.
• prefixos de dias da semana não são suportados.

Os usuários do McFly simplesmente precisam entender que a especificação do fuso horário no carimbo de data e hora não é permitida . McFly sempre usará seu fuso horário local .

Para obter mais detalhes, consulte a documentação chrono-systemd-time .

Regex

Dump suporta comandos de filtragem com regex. A sintaxe regex segue a regex da caixa.

Por exemplo:

mcfly dump -r ' ^cargo run '

irá despejar todos os prefixos de comando com cargo run .

Você pode usar -r/--regex e opções de tempo ao mesmo tempo.

Por exemplo:

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

irá descartar todos os prefixos de comando com cargo run executada desde 12/09/2023 09:15:30 .

Configurações

Várias configurações podem ser definidas por meio de variáveis ​​de ambiente. Para definir uma configuração, você deve adicionar os seguintes trechos ao seu ~/.bashrc / ~/.zshrc / ~/.config/fish/config.fish .

Modo claro

Para trocar o esquema de cores para uso em um terminal light, defina a variável de ambiente MCFLY_LIGHT .

bash/zsh:

 export MCFLY_LIGHT=TRUE

peixe:

 set -gx MCFLY_LIGHT TRUE

shell do poder:

 $ env: MCFLY_LIGHT = " TRUE "

Dica: no macOS você pode usar o seguinte trecho para que o esquema de cores seja configurado com base nas configurações de todo o sistema:

bash/zsh:

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

Esquema de chaves VIM

Por padrão, o Mcfly usa um esquema de teclas inspirado emacs . Se você quiser mudar para o esquema de chaves inspirado vim , defina a variável de ambiente MCFLY_KEY_SCHEME .

bash/zsh:

 export MCFLY_KEY_SCHEME=vim

peixe:

 set -gx MCFLY_KEY_SCHEME vim

shell do poder:

 $ env: MCFLY_KEY_SCHEME = " vim "

Pesquisa difusa

Para ativar a pesquisa difusa, defina MCFLY_FUZZY como um número inteiro. 0 está desativado; números mais altos pesam em partidas mais curtas. Valores na faixa de 2 a 5 obtiveram bons resultados até agora; experimente alguns e relate o que funciona melhor para você!

bash/zsh:

 export MCFLY_FUZZY=2

peixe:

 set -gx MCFLY_FUZZY 2

shell do poder:

 $ env: MCFLY_FUZZY = 2

Contagem de resultados

Para alterar o número máximo de resultados mostrados, defina MCFLY_RESULTS (padrão: 10).

bash/zsh:

 export MCFLY_RESULTS=50

peixe:

 set -gx MCFLY_RESULTS 50

shell do poder:

 $ env: MCFLY_RESULTS = 50

Excluir sem confirmação

Para excluir sem confirmação, defina MCFLY_DELETE_WITHOUT_CONFIRM como verdadeiro.

bash/zsh:

 export MCFLY_DELETE_WITHOUT_CONFIRM=true

peixe:

 set -gx MCFLY_DELETE_WITHOUT_CONFIRM true

shell do poder:

 $ env: MCFLY_DELETE_WITHOUT_CONFIRM = " true "

Visualização da interface

Para alterar a visualização da interface, defina MCFLY_INTERFACE_VIEW (padrão: TOP ). Opções disponíveis: TOP e BOTTOM

bash/zsh:

 export MCFLY_INTERFACE_VIEW=BOTTOM

peixe:

 set -gx MCFLY_INTERFACE_VIEW BOTTOM

shell do poder:

 $ env: MCFLY_INTERFACE_VIEW = " BOTTOM "

Desativar interface do menu

Para desativar a interface do menu, defina a variável de ambiente MCFLY_DISABLE_MENU .

bash/zsh:

 export MCFLY_DISABLE_MENU=TRUE

peixe:

 set -gx MCFLY_DISABLE_MENU TRUE

shell do poder:

 $ env: MCFLY_DISABLE_MENU = true

Classificação de resultados

Para alterar a classificação dos resultados mostrados, defina MCFLY_RESULTS_SORT (padrão: RANK). Valores possíveis RANK e LAST_RUN

bash/zsh:

 export MCFLY_RESULTS_SORT=LAST_RUN

peixe:

 set -gx MCFLY_RESULTS_SORT LAST_RUN

shell do poder:

 $ env: MCFLY_RESULTS_SORT = " LAST_RUN "

Prompt personalizado

Para alterar o prompt, defina MCFLY_PROMPT (padrão: $ ).

bash/zsh:

 export MCFLY_PROMPT= " ❯ "

peixe:

 set -gx MCFLY_PROMPT " ❯ "

shell do poder:

 $ env: MCFLY_PROMPT = " > "

Observe que apenas prompts de um único caractere são permitidos. definir MCFLY_PROMPT como "<str>" irá redefini-lo para o prompt padrão.

Localização do banco de dados

McFly armazena seu banco de dados SQLite no local padrão do sistema operacional. No OS X, está em ~/Library/Application Support/McFly , no Linux está em $XDG_DATA_DIR/mcfly/history.db (o padrão seria ~/.local/share/mcfly/history.db ) e no Windows , é %LOCALAPPDATA%McFlydatahistory.db . Para suporte legado, se ~/.mcfly/ existir, ele será usado.

Inicialização lenta

Se você tiver um banco de dados de histórico muito grande e notar que o McFly inicia lentamente, você pode definir MCFLY_HISTORY_LIMIT para algo como 10000 para limitar quantos registros são considerados durante a pesquisa. Neste exemplo, o McFly pesquisaria apenas as últimas 10.000 entradas.

Bash TIOCSTI

A partir da versão 6.2 do kernel Linux, alguns sistemas desabilitaram o TIOCSTI (que o McFly usou anteriormente para escrever o comando selecionado). McFly contorna esse problema usando dois atalhos de teclado "fictícios", cujo padrão é ctrl-x 1 e ctrl-x 2 . Se você estiver usando qualquer um deles para outra finalidade, poderá definir MCFLY_BASH_SEARCH_KEYBINDING e MCFLY_BASH_ACCEPT_LINE_KEYBINDING , respectivamente, para algo que não está usando. Se preferir usar o comportamento legado do TIOCSTI, você pode habilitá-lo definindo a variável sysctl dev.tty.legacy_tiocsti como 1 em seu sistema e configurando a variável bash MCFLY_BASH_USE_TIOCSTI como 1 .

HISTTIMEFORMAT

Atualmente, o McFly não analisa ou usa HISTTIMEFORMAT .

Possíveis recursos futuros

• Adicione um screencast ao README.
• Aprender opções de comando comuns e preenchê-las automaticamente na interface de sugestão?
• Classifique os argumentos da linha de comando ao criar a string correspondente ao modelo.
• Possíveis melhorias de priorização:
  • Validação cruzada e seleção explícita do conjunto de treinamento.
  • Aprenda incorporações de comandos

Desenvolvimento

Contribuindo

Contribuições e correções de bugs são incentivadas! No entanto, não podemos fundir PRs que aumentem significativamente a complexidade além do que já é necessário para manter o projeto. Se você estiver em dúvida, fique à vontade para abrir um problema e perguntar.

Executando testes

cargo test

Lançamento (notas para @cantino)

1. Edite Cargo.toml e altere a versão.
2. Editar CHANGELOG.txt
3. Execute cargo clippy e cargo fmt .
4. Recompilar ( cargo build ) e testar ( 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. Deixe a construção terminar.
10. Edite a nova versão no Github.
11. cargo publish
12. TBD: atualize a fórmula homebrew-core em https://github.com/Homebrew/homebrew-core/blob/master/Formula/m/mcfly.rb

Velho:

1. Edite pkg/brew/mcfly.rb e atualize a versão e SHAs. ( shasum -a 256 ... )
2. Edite ../homebrew-mcfly/pkg/brew/mcfly.rb também.
3. cp pkg/brew/mcfly.rb ../homebrew-mcfly/pkg/brew/mcfly.rb
4. Compare com 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