# @heyitsiveen/dotfiles 中文文档

规范地址：https://npmcn.com/package/%40heyitsiveen/dotfiles/

版本：2\.1\.1
npm 元数据更新时间：2026-11-01T07:35:47.455Z
中文译文更新时间：2026-11-01T08:24:44.437Z
软件包许可：MIT

本文由上游 README 机器翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40heyitsiveen/dotfiles
原文对照：https://npmcn.com/package/%40heyitsiveen/dotfiles/?lang=original
项目主页：https://github.com/heyitsiveen/dotfiles#readme
源码仓库：https://github.com/heyitsiveen/dotfiles

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：424 kB，183 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=22\.0\.0
- 运行依赖：4 个
- 首次发布：2026-04-16T07:58:50.494Z
- 最新版本发布：2026-11-01T07:35:47.131Z
- 已发布版本数：28（近 12 个月 28 个）

## 中文简介

交互式命令行设置macOS和Windows 11的dotfiles

## 安装

```sh
npm install @heyitsiveen/dotfiles
```

也可以使用：`pnpm add @heyitsiveen/dotfiles`、`yarn add @heyitsiveen/dotfiles`、`bun add @heyitsiveen/dotfiles`

## README

# heyitsiveen

交互式命令行设置macOS和Windows 11的dotfiles。一个安装、主题化、备份和管理开发环境的命令。

![Demo](https://npmcn.com/package/%40heyitsiveen/dotfiles/assets/demo.gif)

## 目录表

-   [快速入门](https://npmcn.com/package/%40heyitsiveen/dotfiles/#readme-quick-start)
-   [先决条件](https://npmcn.com/package/%40heyitsiveen/dotfiles/#readme-prerequisites)
-   [工具](https://npmcn.com/package/%40heyitsiveen/dotfiles/#readme-tools)
-   [包括什么](https://npmcn.com/package/%40heyitsiveen/dotfiles/#readme-whats-included)
-   [颜色主题](https://npmcn.com/package/%40heyitsiveen/dotfiles/#readme-color-themes)
-   [CLI旗帜](https://npmcn.com/package/%40heyitsiveen/dotfiles/#readme-cli-flags)
-   [它是如何工作的](https://npmcn.com/package/%40heyitsiveen/dotfiles/#readme-how-it-works)
-   [开发](https://npmcn.com/package/%40heyitsiveen/dotfiles/#readme-development)

## 快速入门

```bash
pnpm dlx @heyitsiveen/dotfiles@latest
```

或与其他包运行程序：

```bash
npx @heyitsiveen/dotfiles@latest
bunx @heyitsiveen/dotfiles@latest
yarn dlx @heyitsiveen/dotfiles@latest
```

> **该命令修改主目录。** 它写入到 `~/.config/` （macOS上的Fish配置）或PowerShell配置文件（Windows），以及其他特定于工具的路径。 **现有配置备份到 `~/.config/heyitsiveen/dotfiles/backup/` 在任何覆盖之前。** 预览与 `--dry-run` 第一。撤销与 `--restore` 或者 `--uninstall`.

## 先决条件

| 先决条件 | 为什么 | 安装 |
| --- | --- | --- |
| [Node.js >= 22](https://nodejs.org/) | 运行CLI | `pnpm runtime set node lts -g`， `brew install node`，或者 [nodejs.org](https://nodejs.org/) |
| [书呆子的字体](https://www.nerdfonts.com/) | 汰渍的图标，哦，我的时髦，Neovim | [nerdfonts.com](https://www.nerdfonts.com/) （推荐：JetBrains Mono NF） |
| [家酿](https://brew.sh/) (macOS) / [winget](https://aka.ms/getwinget) (窗口) | 安装工具 | [brew.sh](https://brew.sh/) /预安装在Windows 11上 |

## 工具

命令行会自动检测所有工具，并提供通过Homebrew （macOS）或winget （Windows）安装缺失的工具。

**要求** （dotfiles的核心工具）：

| 工具 | macOS | 窗户 |
| --- | --- | --- |
| Git | `brew install git` | `winget install Git.Git` |
| 鱼壳/ PowerShell | `brew install fish` | `winget install Microsoft.PowerShell` |
| 鬼/ WezTerm | `brew install --cask ghostty` | `winget install wez.wezterm` |
| Neovim | `brew install neovim` | `winget install Neovim.Neovim` |
| tree-sitter-cli | `brew install tree-sitter-cli` | `pnpm add -g tree-sitter-cli` (或 `npm i -g tree-sitter-cli`） |
| C编译器 | `xcode-select --install` | [VS构建工具](https://visualstudio.microsoft.com/visual-cpp-build-tools/) |

> **注意：** 只有在安装Neovim时才需要tree-sit -cli和C编译器。LazyVim使用它们来编译语法解析器。macOS通常通过Xcode命令行工具预先安装了C编译器。

**可选** （提升体验）：

| 工具 | macOS | 窗户 |
| --- | --- | --- |
| tmux | `brew install tmux` | N/A |
| 蝙蝠 | `brew install bat` | `winget install sharkdp.bat` |
| btop | `brew install btop` | `winget install aristocratos.btop4win` |
| ripgrep | `brew install ripgrep` | `winget install BurntSushi.ripgrep.MSVC` |
| fd | `brew install fd` | `winget install sharkdp.fd` |
| eza | `brew install eza` | `winget install eza-community.eza` |
| fastfetch | `brew install fastfetch` | `winget install Fastfetch-cli.Fastfetch` |
| oh-my-posh | N/A | `winget install JanDeDobbeleer.OhMyPosh` |

## 包括什么

### macOS

| 工具 | 描述 |
| --- | --- |
| 鱼壳 | config.fish， 9个conf.d模块，8个函数，3个Tide调色板主题 |
| Ghostty | 终端模拟器与JetBrains单声道，0.9不透明度，3个主题 |
| WezTerm | 具有Solarized/Vercel/Vesper配色方案的跨平台终端 |
| tmux | 7个配置文件（主，键绑定，状态栏，窗格，通知，弹出） |
| Neovim | LazyVim与solizzed -osaka， Snacks, Mason (oxfmt + oxlint)，符合 |
| 蝙蝠 | 配置+ Vercel/Vesper自定义。tmTheme主题 |
| btop | 系统监视器+ 3个主题文件 |
| ripgrep | 智能案例，隐藏文件，常见排除 |
| 克劳德代码 | 6台MCP服务器，克劳德。医学博士,设置 |

### 窗户

| 工具 | 描述 |
| --- | --- |
| PowerShell | 简介，5个模块，3个功能 |
| oh-my-posh | 3个TOML提示主题（Solarized, Vercel, Vesper） |
| WezTerm | windows适应的配置选项卡栏 |
| Neovim | LazyVim（与macOS相同的配置） |
| 蝙蝠 | 配置+自定义主题 |
| btop | 系统监视器+ 3个主题文件 |
| ripgrep | 搜索配置 |
| 克劳德代码 | 6台MCP服务器，克劳德。医学博士,设置 |

> ⚠️ **Claude Code配置是作者的个人设置。** `settings.json` 启用特定的插件，设置 `effortLevel: xhigh`， `advisorModel: opus`，并跳过危险模式权限提示。 `.claude.json` 连接三台MCP服务器（exa, grep, better-auth）。 `CLAUDE.md` 是作者的13条规则指令集。如果你喜欢默认设置， **取消选择“克劳德代码”** 当命令行询问要安装或替换哪个配置中的文件时 `~/.claude/` 后安装。

## 颜色主题

所有工具都有三个主题：

| 主题 | 风格 |
| --- | --- |
| **过度曝光黑暗** | 温暖，低对比度的暗主题（默认） |
| **Vercel** | 最小，高对比度的黑暗主题 |
| **黄昏的** | 柔和，温暖的深色主题与橙色口音 |

在所有已安装的工具中立即切换主题：

```bash
pnpm dlx @heyitsiveen/dotfiles --theme vercel
pnpm dlx @heyitsiveen/dotfiles --theme vesper
pnpm dlx @heyitsiveen/dotfiles --theme solarized-dark
```

## CLI旗帜

| 国旗 | 描述 |
| --- | --- |
| `--platform <macos|windows>` | 跳过操作系统检测 |
| `--dry-run` | 显示未写入文件的计划操作 |
| `--theme <name>` | 切换主题: `solarized-dark`， `vercel`， `vesper` |
| `--restore` | 从备份恢复 |
| `--uninstall` | 删除已安装的dotfiles |
| `--version` | 显示版本 |
| `--help` | 显示使用 |

## 它是如何工作的

1.  检测您的操作系统（macOS或Windows）
2.  检查缺失的工具并提供安装（brew/winget）
3.  显示可用的dotfile配置
4.  选择要安装的配置
5.  你选择一个颜色主题
6.  备份现有的dotfiles（可选- Neovim备份包括LazyVim插件数据）
7.  将配置复制到正确的位置
8.  在所有工具中激活您选择的主题
9.  检查更新并在有新版本可用时通知您

后续运行检测现有安装并提供：

-   **全新安装** - backup + overwrite
-   **更新** -应用新版本包的更改
-   **改变主题** -在所有工具之间切换颜色
-   **卸载** -删除配置，卸载工具（brew/winget），或两者兼而有之
-   **恢复** -从每个工具带时间戳的备份中恢复

## 开发

这个回购使用 **规划**． 看到 [文档/ pnpm-setup.md](https://npmcn.com/package/%40heyitsiveen/dotfiles/docs/pnpm-setup.md) 如果你不知道 拥有它——你不需要先安装Node， pnpm自带。

```bash
# Install dependencies (Node is fetched automatically per devEngines.runtime)
pnpm install

# Build
pnpm run build

# Run locally
node dist/index.mjs

# Run all checks (typecheck + lint + format)
pnpm run check

# Previously (replaced by pnpm — kept for reference):
# npm install && npm run build && npm run check
# bun install && bun run build && bun run check
```

**导向钩子** 都是通过 [沙哑的](https://typicode.github.io/husky/) + [lint-staged](https://github.com/lint-staged/lint-staged)． 每一个 `git commit` 自动:

1.  格式上演 `.ts` 带有oxfmt的文件
2.  绑带上演 `.ts` 带有oxlint的文件
3.  使用tsc对项目进行类型检查

## 许可证

麻省理工学院

## 常见问题

### @heyitsiveen/dotfiles 是什么？

交互式命令行设置macOS和Windows 11的dotfiles

### 如何安装 @heyitsiveen/dotfiles？

在项目目录运行 npm install @heyitsiveen/dotfiles，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 heyitsiveen-dotfiles，可以用 npx heyitsiveen-dotfiles 直接运行。

### @heyitsiveen/dotfiles 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/heyitsiveen\_\_dotfiles 是否存在。

### @heyitsiveen/dotfiles 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @heyitsiveen/dotfiles 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @heyitsiveen/dotfiles 可以商用吗？

@heyitsiveen/dotfiles 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @heyitsiveen/dotfiles 还在维护吗？

最新版本 2\.1\.1 发布于 2026/11/01（2 天前）；至今共发布 28 个版本，其中过去 12 个月发布了 28 个；首次发布于 2026/04/16。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。