# @gajae-code/natives 中文文档

规范地址：https://npmcn.com/package/%40gajae-code/natives/

版本：0\.21\.0
npm 元数据更新时间：2026-11-16T05:03:54.424Z
中文译文更新时间：2026-11-16T05:04:30.754Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40gajae-code/natives
原文对照：https://npmcn.com/package/%40gajae-code/natives/?lang=original
项目主页：https://gajae-code.com/
源码仓库：https://github.com/Yeachan-Heo/gajae-code

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

- 包体积（解压后）：219 kB，11 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-05-27T18:46:26.952Z
- 最新版本发布：2026-11-16T05:03:54.064Z
- 近 30 天下载量：9268（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：160（近 12 个月 160 个）

## 中文简介

用于grep、剪贴板、图像处理、语法突出显示、PTY和通过N-API的 shell 操作的原生 Rust 绑定

## 安装

```sh
npm install @gajae-code/natives
```

也可以使用：`pnpm add @gajae-code/natives`、`yarn add @gajae-code/natives`、`bun add @gajae-code/natives`

## README

# @gajae-code/内语

通过 N-API 的原始 Rust 功能 .

## 里面的东西

-   **Grep 读取**: 基于 Regex 的搜索由 riggrep 的引擎提供动力, 并配对本地文件
-   **查找**: 基于 gitignore 支持的基于 glob 的文件/目录发现(纯类型脚本通过 `globPaths`(中文(简体) )
-   **十六届**: SIXEL 能力终端的终端图像编码(解码、调整大小、编码一次)

通用图像处理(文件和缓冲器的解码/调整大小/编码) 住在这里 [`Bun.Image`](https://bun.com/docs/runtime/image) 在联署材料方面 6XEL编码器只载货箱,因为不存在内置等同物 那个终端协议.

## 使用量

```typescript
import { grep, find, encodeSixel } from "@gajae-code/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",
});

// SIXEL encode for a terminal cell box (px)
const sequence = encodeSixel(pngBytes, widthPx, heightPx);
```

## 大楼

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

# Type check
bun run check
```

## 建筑

```
crates/pi-natives/       # Rust source (workspace member)
  src/lib.rs             # N-API exports
  src/sixel.rs           # SIXEL terminal-image encoding
  Cargo.toml             # Rust dependencies
native/                  # Stable JS/types loader files
  index.js               # Loads the host addon
  index.d.ts             # Generated public API types
packages/natives-*/      # Optional per-platform prebuilt addon packages
  native/pi_natives.<platform>-<arch>-modern.node   # x64 modern ISA (AVX2)
  native/pi_natives.<platform>-<arch>-baseline.node # x64 baseline ISA
  native/pi_natives.<platform>-<arch>.node          # non-x64 build artifact
```

## 常见问题

### @gajae-code/natives 是什么？

用于grep、剪贴板、图像处理、语法突出显示、PTY和通过N-API的 shell 操作的原生 Rust 绑定

### 如何安装 @gajae-code/natives？

在项目目录运行 npm install @gajae-code/natives，或使用 pnpm add / yarn add / bun add。

### @gajae-code/natives 支持 TypeScript 吗？

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

### @gajae-code/natives 支持 ESM 还是 CommonJS？

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

### @gajae-code/natives 可以商用吗？

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

### @gajae-code/natives 的下载量有多少？

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

### @gajae-code/natives 还在维护吗？

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

