Project Icon

xdg-ninja

智能清理主目录 保持配置文件井然有序

xdg-ninja是一款智能检查和整理用户主目录的shell脚本工具。它能自动识别冗余配置文件,并给出规范化存放建议。支持多种安装方式,包括手动、Nix和Homebrew等。用户可自定义检查项目,也可使用配套工具自动生成配置。xdg-ninja致力于帮助用户构建整洁规范的主目录结构,提升系统管理效率。

xdg-ninja

因为你不会让任何人随意进入你的 $HOME

一个检查你的 $HOME 目录中不需要的文件和目录的 shell 脚本。

xdg-ninja 命令输出

xdg-ninja 遇到它已知的文件或目录时,它会告诉你是否可以将其移动到适当的位置,以及如何操作。

这些配置来自 arch wiki 上的 XDG_BASE_DIR 页面antidot(感谢 Scr0nch 编写的转换工具),以及其他用户的众包贡献。

安装

手动安装

克隆仓库,然后运行 ./xdg-ninja.sh 脚本。

git clone https://github.com/b3nj5m1n/xdg-ninja
cd xdg-ninja
./xdg-ninja.sh

这将运行默认配置中的所有测试。

Nix

启用 flakes,然后运行以下命令:

nix run github:b3nj5m1n/xdg-ninja

Homebrew

[!注意] 由于 xdg-ninja 的开发方式,不会发布版本,所以 Homebrew 提供的是旧版本,因此你必须从 git HEAD 安装和升级 xdg-ninja。参考:#204

运行通用的 brew upgrade 时,Homebrew 不会升级 xdg-ninja,你必须从 git HEAD 专门升级 xdg-ninja见下文

安装:

brew install xdg-ninja --HEAD

升级:

brew upgrade xdg-ninja --fetch-HEAD

其他包管理器

xdg-ninja 在许多其他包管理器中都可用。

完整列表可在 repology 页面 上查看。

按照你的包管理器的说明安装 xdg-ninja

贡献

依赖

  • 你喜欢的符合 POSIX 标准的 shell(bashzshdash 等)
  • jq 用于解析 json 文件
  • find

可选

  • glow 用于在终端中渲染 Markdown(batpygmentizehighlight 可作为备选,但 glow 的输出更清晰,因此推荐使用 glow)

配置

配置在 ./programs/ 目录中完成,该目录应与 xdg-ninja.sh 脚本位于同一工作目录。这可以通过 XN_PROGRAMS_DIR 环境变量进行覆盖。

你定义一个程序,然后列出该程序无情地放入你的 $HOME 目录的文件和目录。

对于每个文件/目录,你需要指定它是否可以被(重新)移动。

如果可以,你还需要用 Markdown 格式指定如何实现这一点的说明。 此目录中的文件可以使用任何名称,但建议使用程序的名称。

自动生成配置

对于x86_64 Linux系统,你可以从releases页面下载xdgnj二进制文件。

或者,你可以使用cabalstack从源代码构建,使用nix flake或使用提供的docker镜像。

需要明确的是,这只是一个帮助你自动生成配置文件的工具,你仍然只需要你的shell来运行测试

可用命令

xdgnj add # 添加新配置
xdgnj prev programs/FILE.json # 预览程序的配置
xdgnj edit programs/FILE.json # 编辑程序的配置
xdgnj run # 大致相当于运行shell脚本

预构建二进制文件

[!重要] 这些二进制文件只能在x86_64 Linux系统上运行。

curl -fsSL -o xdgnj https://github.com/b3nj5m1n/xdg-ninja/releases/latest/download/xdgnj
chmod +x xdgnj

从源代码构建

你可以使用cabal buildstack build

Nix

nix run github:b3nj5m1n/xdg-ninja#xdgnj-bin ...

Docker

使用./haskell/build/中提供的dockerfile。

手动创建配置

我们将以git为例。

默认情况下,它会将文件.gitconfig放在$HOME中。

幸运的是,git支持XDG规范,所以我们只需将文件移动到$XDG_CONFIG_HOME/git/config即可。

我们可以使用最后一句话作为我们的指示。在这种情况下,没有换行符,所以将此字符串转义为json格式很简单,但是,这是你通常应该采用的方法:

echo "幸运的是,git支持XDG规范,所以我们只需将文件移动到_$XDG_CONFIG_HOME/git/config_即可。" | jq -aRs .

让我们看看这个命令对于更复杂的内容会输出什么。

这是一个示例文件:

cat example.md
目前无法修复。

_(但你可能只需删除该目录)_

以下是将此文件输入到jq的结果:

cat example.md | jq -aRs .
"目前无法修复。\n\n_(但你可能只需删除该目录)_\n"

现在,我们可以组装我们的最终json文件:

{
    "name": "git",
    "files": [
        {
            "path": "$HOME/.gitconfig",
            "movable": true,
            "help": "幸运的是,git支持XDG规范,所以我们只需将文件移动到_$XDG_CONFIG_HOME/git/config_即可。\n"
        }
    ]
}

将此内容保存为./programs/目录中的git.json,脚本就会读取并检查该文件。

如果你为官方存储库中尚未包含的文件创建了配置,请确保创建一个拉取请求,以便其他人也能从中受益。

项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。

Project Cover

AI写歌

Suno AI是一个革命性的AI音乐创作平台,能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐,Suno AI都是音乐爱好者和专业人士的理想选择。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

Kimi

Kimi AI助手提供多语言对话支持,能够阅读和理解用户上传的文件内容,解析网页信息,并结合搜索结果为用户提供详尽的答案。无论是日常咨询还是专业问题,Kimi都能以友好、专业的方式提供帮助。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术,为商家提供一键生成商品图和营销文案的服务,显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台,让商品第一时间被种草。

Project Cover

吐司

探索Tensor.Art平台的独特AI模型,免费访问各种图像生成与AI训练工具,从Stable Diffusion等基础模型开始,轻松实现创新图像生成。体验前沿的AI技术,推动个人和企业的创新发展。

Project Cover

SubCat字幕猫

SubCat字幕猫APP是一款创新的视频播放器,它将改变您观看视频的方式!SubCat结合了先进的人工智能技术,为您提供即时视频字幕翻译,无论是本地视频还是网络流媒体,让您轻松享受各种语言的内容。

Project Cover

美间AI

美间AI创意设计平台,利用前沿AI技术,为设计师和营销人员提供一站式设计解决方案。从智能海报到3D效果图,再到文案生成,美间让创意设计更简单、更高效。

Project Cover

AIWritePaper论文写作

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号