Karin v1.7.14

主题模式

环境安装 ​

字数
1582 字
阅读时间
7 分钟

Node.js 铛铛铛！必需品 ​

友情提示

Karin是一个基于Node.js开发的可爱机器人框架，在 MIT License 下开源~

版本要求 ​

友情提示

🌟 推荐使用 Node.js 的 LTS 版本(v22+)，这样可以获得最稳定的体验哦！

小贴士：

  • 最低支持 v18+，推荐使用 v22+
  • 虽然理论上支持 v16+，但是为了获得最佳体验还是推荐使用更新版本啦
  • 官方的LTS版本，所以跟着大家一起用 v22+ 准没错！
  • 当然啦，如果你只是想尝鲜，用其他版本也不是不可以 😉

安装方式 ​

友情提示

如果没有一定的基础，请勿随意使用nvm安装，否则可能会出现一些奇奇怪怪的问题哦

Windows 系统安装方法

Windows 系统 ​

  1. 使用官方安装包(推荐)

  2. 使用 nvm-windows (适合需要管理多个 Node.js 版本的用户)

    • 访问 nvm-windows 下载最新版本
    • 下载 nvm-setup.exe 并安装
    • 打开命令提示符(cmd)，运行:
      bash
      nvm install latest  # 安装最新版
nvm install lts    # 安装 LTS 版本
nvm use xxx       # 使用指定版本
macOS 系统安装方法

macOS 系统 ​

  1. 使用 Homebrew

    bash
    brew install node

  2. 使用 nvm (推荐)

    bash
    # 1. 安装 nvm
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash

# 2. 安装 Node.js
nvm install node    # 安装最新版
nvm install --lts  # 安装 LTS 版本
nvm use xxx       # 使用指定版本
Linux 系统安装方法

Linux 系统 ​

  1. 使用包管理器
bash
curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
sudo apt-get install -y nodejs
bash
curl -fsSL https://rpm.nodesource.com/setup_lts.x | sudo bash -
sudo yum install -y nodejs
  1. 使用 nvm (推荐)
    bash
    # 1. 安装 nvm
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash

# 2. 安装 Node.js
nvm install node    # 安装最新版
nvm install --lts  # 安装 LTS 版本
nvm use xxx       # 使用指定版本

下载地址 ​

友情提示

以下下载链接由 npmmirror 提供的国内镜像，如果无法访问请前往 Node.js 官网 下载。

正在获取最新版本信息...

验证安装 ​

友情提示

npm 是 Node.js 的自带的包管理器，安装Node.js时会自动安装

安装完成后，打开终端输入以下命令验证:

bash
node -v  # 查看 Node.js 版本
npm -v   # 查看 npm 版本

如果能正确显示版本号，说明安装成功啦！

Git 可选，但强烈推荐！ ​

友情提示

Git 是一个分布式版本控制系统，在 Karin 中主要用于 Git 插件的安装和更新

Windows 安装 ​

  1. 下载安装包:

  2. 运行安装程序，全部使用默认选项即可

ps: 也就是一路Next，直到安装完成~

macOS 安装 ​

bash
brew install git

Linux 安装 ​

bash
sudo apt-get update
sudo apt-get install git
bash
sudo yum install git

验证安装 ​

bash
git --version  # 显示版本号即为安装成功

包管理器 pnpm 更快更好用！ ​

什么是 pnpm？ ​

pnpm 是一个快速、节省磁盘空间的包管理器。它具有以下特点：

  • 比 npm/yarn 快 2-3 倍
  • 节省磁盘空间，相同的依赖只会被存储一次
  • 支持 monorepo，方便管理多个项目
  • 更安全的依赖管理
  • 你也不想你的依赖吃掉你的硬盘空间吧~

在 Karin 框架中，pnpm 的工作区(workspace)功能尤为重要：

  • 所有的Git插件都是一个独立的工作区
  • 可以统一管理所有插件的依赖
  • 方便进行插件的开发和调试

安装 pnpm ​

友情提示

pnpm 在10.x版本引入了一个破坏性变更
目前暂时无法很好的对此进行兼容
请务必使用 pnpm v9 版本
如果已经安装了pnpm v10的小伙伴请不要跳过此步骤

bash
# 安装包管理器，启动！
npm install pnpm@9 -g
bash
# 国内加速版！
npm --registry=https://registry.npmmirror.com install pnpm@9 -g
bash
# 查看版本
pnpm -v

配置镜像源 ​

友情提示

国内的小伙伴们注意啦！如果访问官方源太慢，咱们换个源吧！

点击查看换源大法

🚀 换源指南：

bash
# 推荐使用这个，速度杠杠的！
npm config set registry https://registry.npmmirror.com
bash
# 淘宝源不行？试试腾讯源！
npm config set registry https://mirrors.cloud.tencent.com/npm
bash
# 想换回官方源也可以哦
npm config set registry https://registry.npmjs.org
bash
# 看看现在用的是哪个源
npm config get registry

pnpm 常用命令 ​

小贴士

  • 后面我们会经常用到 pnpm，建议先熟悉一下这些基本命令哦！
  • 在开发插件时，工作区相关的命令会特别有用
bash
# 工作区相关
pnpm -r install           # 安装所有工作区的依赖
pnpm --filter <pkg> add   # 为指定工作区安装依赖
pnpm -r update           # 更新所有工作区的依赖

# 基础命令
pnpm install      # 安装所有依赖
pnpm add <pkg>    # 安装某个包
pnpm add -D <pkg> # 安装开发依赖
pnpm up           # 更新所有依赖
pnpm update       # 更新所有依赖
pnpm rm <pkg>     # 删除某个包
pnpm remove <pkg> # 删除某个包
pnpm run <script> # 运行 package.json 中定义的脚本