@f5-sales-demo/pi-natives

中文文档
23.10.13发布于 2026/11/13MITTypeScriptESM + CJS零依赖构建来源已验证近 30 天下载 8991

Native Rust bindings for grep, clipboard, image processing, syntax highlighting, PTY, and shell operations via N-API

原始使用文档
文档目录4 节
  1. What's Inside
  2. Usage
  3. Building
  4. Architecture

@f5-sales-demo/pi-natives

Native Rust functionality via N-API.

What's Inside

  • Grep: Regex-based search powered by ripgrep's engine with native file walking and matching
  • Find: Glob-based file/directory discovery with gitignore support (pure TypeScript via globPaths)
  • Image: Image processing via photon-rs (resize, format conversion) exposed through N-API

Usage

import { grep, find } from "@f5-sales-demo/pi-natives";

// Grep for a pattern
const results = await grep({
 pattern: "TODO",
 path: "/path/to/project",
 glob: "*.ts",
 context: 2,
});

// Find files
const files = await find({
 pattern: "*.rs",
 path: "/path/to/project",
 fileType: "file",
});

// Image processing
const pngBytes = await new Bun.Image(bytes).resize(800, 600).png().bytes();

Building

# Build native addon from workspace root (requires Rust)
bun run build

# Type check
bun run check

Architecture

crates/pi-natives/       # Rust source (workspace member)
  src/lib.rs             # N-API exports
  src/image.rs           # SIXEL image decoding and encoding
  Cargo.toml             # Rust dependencies
native/                  # Native addon binaries
  pi_natives.<platform>-<arch>-modern.node   # x64 modern ISA (AVX2)
  pi_natives.<platform>-<arch>-baseline.node # x64 baseline ISA
  pi_natives.<platform>-<arch>.node          # non-x64 build artifact
src/                     # TypeScript wrappers
  native.ts              # Native addon loader
  index.ts               # Public API

版本与发布记录

@f5-sales-demo/pi-natives 共发布 450 个版本,首次发布于 2026/06/26;过去 12 个月发布了 450 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
23.10.13latest2026/11/131 天前
23.10.122026/11/113 天前
23.10.112026/11/113 天前
23.10.82026/11/0410 天前
23.10.72026/10/3114 天前
23.10.62026/10/3114 天前

其他发布通道:backfill → 23.3.4。

关于 @f5-sales-demo/pi-natives 的常见问题

@f5-sales-demo/pi-natives 是什么?

Native Rust bindings for grep, clipboard, image processing, syntax highlighting, PTY, and shell operations via N-API

如何安装 @f5-sales-demo/pi-natives?

在项目目录运行 npm install @f5-sales-demo/pi-natives,或使用 pnpm add / yarn add / bun add。

@f5-sales-demo/pi-natives 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@f5-sales-demo/pi-natives 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@f5-sales-demo/pi-natives 可以商用吗?

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

@f5-sales-demo/pi-natives 的下载量有多少?

根据 npm 官方下载统计,@f5-sales-demo/pi-natives 在 2026/10/14 – 2026/11/12 这 30 天内被下载 8,991 次,日均约 300 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@f5-sales-demo/pi-natives 还在维护吗?

最新版本 23.10.13 发布于 2026/11/13(1 天前);至今共发布 450 个版本,其中过去 12 个月发布了 450 个;首次发布于 2026/06/26。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。