Главная страница>Связанные с программированием>Другой исходный код
Скачать

Ищу со-сопровождающих : сейчас у меня мало времени на поддержку этого проекта. Если кто-то захочет присоединиться и стать со-сопровождающим, мы будем признательны!

McFly — пролистайте историю своей оболочки

скриншот

McFly заменяет поиск по истории оболочки ctrl-r по умолчанию на интеллектуальную поисковую систему, которая учитывает ваш рабочий каталог и контекст недавно выполненных команд. Предложения McFly расставляются по приоритетам в режиме реального времени с помощью небольшой нейронной сети.

TL;DR: обновленный ctrl-r , благодаря которому результаты истории имеют смысл для того, над чем вы сейчас работаете.

Функции

  • Перепривязывает ctrl-r для вызова полноэкранного поиска по обратной истории с приоритетом небольшой нейронной сети.
  • Дополняет историю вашей оболочки для отслеживания статуса завершения команды, отметки времени и каталога выполнения в базе данных SQLite.
  • Также сохраняется ваш обычный файл истории оболочки, так что вы можете прекратить использование McFly, когда захотите.
  • Поддержка Unicode повсюду.
  • Включает в себя простое действие по очистке любого элемента истории из базы данных McFly и файлов истории вашей оболочки.
  • Разработан с возможностью расширения для других оболочек в будущем.
  • Написан на Rust, поэтому это быстро и безопасно.
  • Вы можете ввести % , чтобы соответствовать любому количеству символов при поиске.

Расстановка приоритетов

Ключевой особенностью McFly является интеллектуальная приоритезация команд, основанная на небольшой нейронной сети, работающей в режиме реального времени. Цель состоит в том, чтобы команда, которую вы хотите запустить, всегда была одной из лучших предложений.

Предлагая команду, МакФлай учитывает:

  • Каталог, в котором вы выполнили команду. Вероятно, в будущем вы запустите эту команду в том же каталоге.
  • Какие команды вы ввели перед командой (например, контекст выполнения команды).
  • Как часто вы запускаете команду.
  • Когда вы в последний раз запускали команду.
  • Если вы уже выбрали команду в McFly.
  • Исторический статус выхода команды. Вероятно, вы не захотите запускать старые неудачные команды.

Установка

Установите с помощью Homebrew (на macOS или Linux)

  1. Установите mcfly : 

    brew install mcfly

  2. Добавьте следующее в конец файла ~/.bashrc , ~/.zshrc или ~/.config/fish/config.fish :

    Баш: 

     eval " $( mcfly init bash ) "

    Зш: 

     eval " $( mcfly init zsh ) "

    Рыба: 

    mcfly init fish | source

  3. Бегать . ~/.bashrc / . ~/.zshrc / source ~/.config/fish/config.fish или перезапустите эмулятор терминала.

Удаление с помощью Homebrew

  1. Удалить mcfly : 
    brew uninstall mcfly
  2. Удалите строки, добавленные вами в ~/.bashrc / ~/.zshrc / ~/.config/fish/config.fish .

Установка с помощью MacPorts (на macOS)

  1. Обновите дерево портов 

    sudo port selfupdate

  2. Установите mcfly : 

    sudo port install mcfly

  3. Добавьте следующее в конец вашего файла ~/.bashrc , ~/.zshrc или ~/.config/fish/config.fish соответственно:

    Баш: 

     eval " $( mcfly init bash ) "

    Зш: 

     eval " $( mcfly init zsh ) "

    Рыба: 

    mcfly init fish | source

  4. Бегать . ~/.bashrc / . ~/.zshrc / source ~/.config/fish/config.fish или перезапустите эмулятор терминала.

Удаление с помощью MacPorts

  1. Удалить mcfly : 
    sudo port uninstall mcfly
  2. Удалите строки, добавленные вами в ~/.bashrc / ~/.zshrc / ~/.config/fish/config.fish .

Установка с помощью нашего скрипта установки (macOS или Linux)

  1. curl -LSfs https://raw.githubusercontent.com/cantino/mcfly/master/ci/install.sh | sh -s -- --git cantino/mcfly (или, если у текущего пользователя нет прав на редактирование /usr/local/bin, используйте sudo sh -s .)

  2. Добавьте следующее в конец файла ~/.bashrc , ~/.zshrc или ~/.config/fish/config.fish соответственно:

    Баш: 

     eval " $( mcfly init bash ) "

    Зш: 

     eval " $( mcfly init zsh ) "

    Рыба: 

    mcfly init fish | source

  3. Бегать . ~/.bashrc / . ~/.zshrc / source ~/.config/fish/config.fish или перезапустите эмулятор терминала.

Установка вручную с GitHub (macOS или Linux)

  1. Загрузите последнюю версию с GitHub.

  2. Установите в папку $PATH . (Например, вы можете создать каталог ~/bin , скопировать mcfly в это место и добавить export PATH="$PATH:$HOME/bin" в ваш .bashrc / .zshrc или запустить set -Ua fish_user_paths "$HOME/bin" для рыбы.)

  3. Добавьте следующее в конец вашего ~/.bashrc , ~/.zshrc или ~/.config/fish/config.fish соответственно:

    Баш: 

     eval " $( mcfly init bash ) "

    Зш: 

     eval " $( mcfly init zsh ) "

    Рыба: 

    mcfly init fish | source

  4. Бегать . ~/.bashrc / . ~/.zshrc / source ~/.config/fish/config.fish или перезапустите эмулятор терминала.

Установить вручную из исходного кода (macOS, Linux или Windows)

  1. Установите Rust 1.40 или новее.

  2. Запустите git clone https://github.com/cantino/mcfly и cd mcfly

  3. Запустите cargo install --path .

  4. Убедитесь, что ~/.cargo/bin находится в вашем $PATH .

  5. Добавьте следующее в конец ~/.bashrc , ~/.zshrc , ~/.config/fish/config.fish или powershell $PROFILE соответственно:

    Баш: 

     eval " $( mcfly init bash ) "

    Зш: 

     eval " $( mcfly init zsh ) "

    Рыба: 

    mcfly init fish | source

    Ядро Powershell (pwsh) 

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

  6. Бегать . ~/.bashrc / . ~/.zshrc / source ~/.config/fish/config.fish / . $PROFILE или перезапустите эмулятор терминала.

Установить через Zinit

  • Добавьте приведенный ниже код в ваш zshrc. 

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

  • Он загрузит и установит mcfly.

  • $(mcfly init zsh) будет выполнен после запроса

iTerm2

Чтобы пользовательский интерфейс McFly не испортил историю прокрутки в iTerm2, убедитесь, что этот параметр снят:

iterm2 инструкции пользовательского интерфейса

Дамп истории

McFly может выгрузить историю команд в стандартный вывод .

Например: 

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

выгрузит команду, выполненную с 01.01.2023 00:00:00.0 по 12.09.2023 09:15:30 ( эксклюзивно ) в формате json . Вы также можете указать csv в качестве формата дампа с помощью --format csv .

Каждый элемент в дамп-команде имеет следующие поля:

  • cmd : команда запуска.
  • when_run : время выполнения команды в вашем местном часовом поясе.

Вы можете сбросить всю историю команд без каких-либо аргументов: 

mcfly dump

Формат временной метки

McFly анализирует временные метки через chrono-systemd-time , нестрогую реализацию systemd.time, со следующими исключениями:

  • единицы времени должны сопровождать все значения интервала времени.
  • суффиксы часовых поясов не поддерживаются.
  • Префиксы дней недели не поддерживаются.

Пользователям McFly просто необходимо понимать , что указание часового пояса в метке времени запрещено . McFly всегда будет использовать ваш местный часовой пояс .

Для получения более подробной информации обратитесь к документации chrono-systemd-time .

регулярное выражение

Дамп поддерживает команды фильтрации с помощью регулярных выражений. Синтаксис регулярного выражения соответствует регулярному выражению crate.

Например: 

mcfly dump -r ' ^cargo run '

сбросит все префиксы команд с помощью cargo run .

Вы можете использовать -r/--regex и параметры времени одновременно.

Например: 

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

выгрузит все префиксы команд с cargo run , запущенным с 12 сентября 2023 г., 09:15:30 .

Настройки

Ряд настроек можно установить через переменные среды. Чтобы установить настройку, вам следует добавить следующие фрагменты в ваш ~/.bashrc / ~/.zshrc / ~/.config/fish/config.fish .

Светлый режим

Чтобы поменять цветовую схему для использования в световом терминале, установите переменную среды MCFLY_LIGHT .

баш/зш: 

 export MCFLY_LIGHT=TRUE

рыба: 

 set -gx MCFLY_LIGHT TRUE

силовая оболочка: 

 $ env: MCFLY_LIGHT = " TRUE "

Совет: в macOS вы можете использовать следующий фрагмент для настройки цветовой схемы на основе общесистемных настроек:

баш/зш: 

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

Схема ключей VIM

По умолчанию Mcfly использует схему ключей, основанную на emacs . Если вы хотите переключиться на схему ключей, основанную на vim , установите переменную среды MCFLY_KEY_SCHEME .

баш/зш: 

 export MCFLY_KEY_SCHEME=vim

рыба: 

 set -gx MCFLY_KEY_SCHEME vim

силовая оболочка: 

 $ env: MCFLY_KEY_SCHEME = " vim "

Нечеткий поиск

Чтобы включить нечеткий поиск, задайте для MCFLY_FUZZY целое число. 0 выключен; более высокие числа имеют вес в пользу более коротких совпадений. Значения в диапазоне 2–5 пока дают хорошие результаты; попробуйте несколько и сообщите, что подойдет вам лучше всего!

баш/зш: 

 export MCFLY_FUZZY=2

рыба: 

 set -gx MCFLY_FUZZY 2

силовая оболочка: 

 $ env: MCFLY_FUZZY = 2

Количество результатов

Чтобы изменить максимальное количество отображаемых результатов, установите MCFLY_RESULTS (по умолчанию: 10).

баш/зш: 

 export MCFLY_RESULTS=50

рыба: 

 set -gx MCFLY_RESULTS 50

силовая оболочка: 

 $ env: MCFLY_RESULTS = 50

Удалить без подтверждения

Чтобы удалить без подтверждения, установите для MCFLY_DELETE_WITHOUT_CONFIRM значение true.

баш/зш: 

 export MCFLY_DELETE_WITHOUT_CONFIRM=true

рыба: 

 set -gx MCFLY_DELETE_WITHOUT_CONFIRM true

силовая оболочка: 

 $ env: MCFLY_DELETE_WITHOUT_CONFIRM = " true "

Вид интерфейса

Чтобы изменить вид интерфейса, установите MCFLY_INTERFACE_VIEW (по умолчанию: TOP ). Доступные варианты: TOP и BOTTOM

баш/зш: 

 export MCFLY_INTERFACE_VIEW=BOTTOM

рыба: 

 set -gx MCFLY_INTERFACE_VIEW BOTTOM

силовая оболочка: 

 $ env: MCFLY_INTERFACE_VIEW = " BOTTOM "

Отключить интерфейс меню

Чтобы отключить интерфейс меню, установите переменную среды MCFLY_DISABLE_MENU .

баш/зш: 

 export MCFLY_DISABLE_MENU=TRUE

рыба: 

 set -gx MCFLY_DISABLE_MENU TRUE

силовая оболочка: 

 $ env: MCFLY_DISABLE_MENU = true

Сортировка результатов

Чтобы изменить сортировку отображаемых результатов, установите MCFLY_RESULTS_SORT (по умолчанию: RANK). Возможные значения RANK и LAST_RUN

баш/зш: 

 export MCFLY_RESULTS_SORT=LAST_RUN

рыба: 

 set -gx MCFLY_RESULTS_SORT LAST_RUN

силовая оболочка: 

 $ env: MCFLY_RESULTS_SORT = " LAST_RUN "

Пользовательская подсказка

Чтобы изменить приглашение, установите MCFLY_PROMPT (по умолчанию: $ ).

баш/зш: 

 export MCFLY_PROMPT= " ❯ "

рыба: 

 set -gx MCFLY_PROMPT " ❯ "

силовая оболочка: 

 $ env: MCFLY_PROMPT = " > "

Обратите внимание, что разрешены только односимвольные запросы. установка для MCFLY_PROMPT значения "<str>" приведет к сбросу его к приглашению по умолчанию.

Расположение базы данных

McFly хранит свою базу данных SQLite в стандартном для ОС месте. В OS X это ~/Library/Application Support/McFly , в Linux — $XDG_DATA_DIR/mcfly/history.db (по умолчанию ~/.local/share/mcfly/history.db ), а в Windows , это %LOCALAPPDATA%McFlydatahistory.db . Для поддержки устаревших версий, если существует ~/.mcfly/ , вместо него используется он.

Медленный запуск

Если у вас очень большая база данных истории и вы заметили, что McFly запускается медленно, вы можете установить MCFLY_HISTORY_LIMIT примерно на 10 000, чтобы ограничить количество записей, учитываемых при поиске. В этом примере McFly будет искать только последние 10 000 записей.

Баш ТИОКСТИ

Начиная с версии ядра Linux 6.2, в некоторых системах отключена функция TIOCSTI (которая ранее использовалась McFly для записи выбранной команды). McFly решает эту проблему, используя две «фиктивные» комбинации клавиш, которые по умолчанию — ctrl-x 1 и ctrl-x 2 . Если вы используете любой из них для другой цели, вы можете установить MCFLY_BASH_SEARCH_KEYBINDING и MCFLY_BASH_ACCEPT_LINE_KEYBINDING соответственно на то, что вы не используете. Если вы предпочитаете использовать устаревшее поведение TIOCSTI, вы можете включить его, установив для переменной sysctl dev.tty.legacy_tiocsti значение 1 в вашей системе и задав для переменной bash MCFLY_BASH_USE_TIOCSTI значение 1 .

ИСТИМЕФОРМАТ

McFly в настоящее время не анализирует и не использует HISTTIMEFORMAT .

Возможные будущие функции

  • Добавьте скринкаст в README.
  • Изучить общие параметры команд и автоматически заполнять их в пользовательском интерфейсе подсказок?
  • Сортируйте аргументы командной строки при обнаружении строки, соответствующей шаблону.
  • Возможные улучшения приоритезации:
    • Перекрестная проверка и явный выбор обучающего набора.
    • Изучите встраивание команд

Разработка

Содействие

Вклады и исправления ошибок приветствуются! Однако мы не можем объединять PR, которые значительно усложняют задачу, превышающую ту, которая уже необходима для поддержки проекта. Если у вас есть сомнения, не стесняйтесь открыть проблему и спросить.

Запуск тестов

cargo test

Выпуск (примечания для @cantino)

  1. Отредактируйте Cargo.toml и улучшите версию.
  2. Изменить CHANGELOG.txt
  3. Запустите cargo clippy и cargo fmt .
  4. Перекомпилируйте ( cargo build ) и протестируйте ( 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. Пусть сборка закончится.
  10. Отредактируйте новый выпуск на Github.
  11. cargo publish
  12. Будет определено позже: обновите формулу ядра домашнего пивоварения по адресу https://github.com/Homebrew/homebrew-core/blob/master/Formula/m/mcfly.rb.

Старый:

  1. Отредактируйте pkg/brew/mcfly.rb и обновите версию и SHA. ( shasum -a 256 ... )
  2. Также отредактируйте ../homebrew-mcfly/pkg/brew/mcfly.rb .
  3. cp pkg/brew/mcfly.rb ../homebrew-mcfly/pkg/brew/mcfly.rb
  4. Сравните с 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
Расширять
Дополнительная информация
Связанные приложения
Рекомендуем вам
Связанные новости Все