@ikun-kit/fepull
v1.0.5
Published
Frontend package management tool for pulling packages from monorepo projects
Downloads
597
Maintainers
Readme
fepull
一个前端包管理工具,用于从 monorepo 项目中拉取特定包,类似 shadcn/ui。
功能特性
- 🎯 从 monorepo 项目中拉取特定包
- ⚡ 高效的稀疏检出,最小化带宽使用
- 🔄 多选包批量安装
- 📊 实时安装进度与详细摘要
- 🔧 交互式配置设置
- 📦 支持多个包条目,源与目标绑定管理
- 🚀 支持 npx、全局安装或项目本地安装
安装方式
使用 npx(推荐)
npx @ikun-kit/fepull init
npx @ikun-kit/fepull install全局安装
pnpm add -g @ikun-kit/fepull
fepull init
fepull install项目安装
pnpm add -D @ikun-kit/fepull
pnpm fepull init
pnpm fepull install快速开始
初始化配置:
fepull init这会创建一个默认的
fepull.config.yml文件。编辑此文件来配置你的包条目。安装包:
fepull install交互式选择包条目和要安装的包。
配置文件
fepull.config.yml 文件结构:
packages:
- name: ikun-react
source:
url: https://github.com/ikun-kit/react
packagesDir: packages
target: ./src/components
description: ikun-kit React 组件库包条目
name: 条目标识符source: 源仓库配置url: Git 仓库 URLpackagesDir: 仓库中包含包的目录
target: 包将被安装到的本地路径description: 可选描述
开发
前置要求
- Node.js >= 18.0.0
- pnpm
设置
# 克隆仓库
git clone <repository-url>
cd fepull
# 安装依赖
pnpm install
# 构建项目
pnpm build
# 开发模式运行
pnpm dev脚本命令
pnpm build- 构建 TypeScript 项目pnpm dev- 监听模式构建pnpm start- 直接运行 CLI
工作原理
- 条目选择:从配置的包条目中选择(源与目标已绑定)
- 包发现:使用 Git 稀疏检出高效获取包目录列表
- 包选择:交互式多选可用包(使用空格选择,回车确认)
- 安装:使用稀疏检出仅下载选定包并复制到目标目录
使用示例
# 初始化项目
fepull init
# → 创建 fepull.config.yml
# → 编辑配置文件,设置包条目(源 + 目标)
# 安装多个组件
fepull install
# → 选择 "ikun-react" 条目
# → 多选包:"button", "input", "dialog"(使用空格选择)
# → 包自动安装到配置的目标目录
# → ✅ button installed successfully
# → ✅ input installed successfully
# → ✅ dialog installed successfully
# → 📋 Installation Summary: ✅ 3 package(s) installed successfully系统要求
- 必须安装 Git 并可访问
- 需要网络连接以下载源仓库
- 对目标目录有写入权限
许可证
MIT
