开源项目 `done` 使用教程

开源项目 done 使用教程

done A fish-shell package to automatically receive notifications when long processes finish. 项目地址: https://gitcode.com/gh_mirrors/do/done

1. 项目介绍

done 是一个为 fish-shell 设计的开源项目，旨在自动通知用户长时间运行的进程已完成。当一个进程运行超过5秒且终端窗口不在前台时，done 会发送通知，使用户无需时刻关注终端窗口。

2. 项目快速启动

安装 done

使用 Fisher 安装

fisher install franciscolourenco/done

手动安装

curl -Lo ~/.config/fish/conf.d/done.fish --create-dirs https://raw.githubusercontent.com/franciscolourenco/done/master/conf.d/done.fish

配置 done

设置最小命令持续时间

默认情况下，done 会在命令运行超过5秒时发送通知。你可以通过以下命令更改此设置：

set -U __done_min_cmd_duration 5000  # 默认: 5000 ms

排除特定命令

你可以通过以下命令排除某些命令，使其不触发通知：

set -U __done_exclude '^git (commit|push|pull|fetch)'  # 默认: 所有 git 命令，除了 push 和 pull

自定义通知命令

你可以通过以下命令自定义通知命令：

set -U __done_notification_command "your-command \$title \$message"

3. 应用案例和最佳实践

案例1：长时间编译任务

在开发过程中，编译大型项目可能需要很长时间。使用 done 可以在编译完成后自动通知你，无需时刻关注终端窗口。

make -j8

案例2：长时间数据处理任务

在进行数据处理时，某些任务可能需要数小时才能完成。使用 done 可以在任务完成后自动通知你，方便你及时查看结果。

python process_data.py

最佳实践

• 合理设置最小命令持续时间：根据你的工作流程，合理设置最小命令持续时间，避免频繁的通知干扰。
• 排除不必要的命令：通过排除特定命令，减少不必要的通知，提高工作效率。

4. 典型生态项目

fish-shell

done 是专门为 fish-shell 设计的插件，fish-shell 是一个用户友好的命令行 shell，提供了丰富的功能和插件支持。

Fisher

Fisher 是一个用于 fish-shell 的插件管理器，简化了插件的安装和管理过程。通过 Fisher，你可以轻松安装和管理 done 插件。

terminal-notifier

在 macOS 上，terminal-notifier 是一个用于发送通知的工具。通过安装 terminal-notifier，done 可以在 macOS 上显示带有图标的通知。

brew install terminal-notifier

通过以上模块的介绍和使用指南，你可以快速上手并充分利用 done 项目，提高工作效率。

done A fish-shell package to automatically receive notifications when long processes finish. 项目地址: https://gitcode.com/gh_mirrors/do/done