# spak **Repository Path**: starpak/spak ## Basic Information - **Project Name**: spak - **Description**: 不过,看我奋笔疾书,让它变成缝合怪先 ❈ - **Primary Language**: Go - **License**: MIT - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2026-07-02 - **Last Updated**: 2026-11-01 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README
Spak — 插件优先的 Node 运行时

starpak spm node MIT CI English

内核、CLI、桌面壳、应用、模组 —— 全是包,全都能换。

## Spak 是什么 **Spak** 是一个插件优先的 Node 运行时家族,发布在 npm 的 `@starpak/*` 作用域下。 内核从配置装插件,应用、模组、桌面壳也都是包 —— 装什么、换什么,由你决定。
万物皆包 · 一条命令到底 · 错误码有契约 · 桌面也是一层
## 快速开始 ```bash npm i -g starpak # 安装:只暴露 spak 与 spm spm setup && spm start # 建工程、启动运行时 spm build -i apps/hello -n hello # 构建单文件产物 spm iwant -i spakos && spm os # 装桌面扩展,启动 Spak OS ```
spm setup 生成的工程骨架
生成的内容: - `apps/hello` — 示例应用 - `mods/hello` — 示例模组 - `docs/` — 八篇中文文档 - `spak.config.yml` — 运行时配置
## 预览
终端实录:spm version、spm iwant --list、spm start
> 画面里的每条命令、每行输出,都来自本机真实运行;配色就是终端的 ANSI 原色。
## 命令速查 | 命令 | 作用 | | :--- | :--- | | `spm build` | 构建单文件产物(node / server / app) | | `spm dev` | watch + HMR 热重启 | | `spm start` | 启动运行时 | | `spm run` | 直接运行 `.spk` | | `spm setup` | 初始化工程与文档 | | `spm install` | 安装应用、模组或扩展 | | `spm remove` | 卸载已安装的包 | | `spm update` | 升级 | | `spm publish` | 打包发布 | | `spm iwant` | 扩展管理 | | `spm os` | 启动 Spak OS | | `spm config` | 读写配置 | | `spm cpc` | 安全检查与沙箱 | | `spm serve` | 服务启停与状态 | | `spm version` | 版本信息 |
## 包地图 16 个包分成四组:入口 `starpak` `spm` `cli`,运行时 `core` `loader` `config` `log` `error`,工具 `util` `lang` `mods`,扩展 `os` `iwant` `apps` `node-b` `ssetps`。
Spak 的 16 个包:门面、运行时、工具与扩展
## 架构 依赖单向向下:`util` → `core` → `log` / `config` / `loader` → `cli` → `spm` → `starpak`。 任何包都不允许反向依赖门面。
依赖链:util → core → log/config/loader → cli → spm → starpak
## 文档 | 文档 | 内容 | | :--- | :--- | | [docs/README.md](docs/README.md) | 文档索引 | | [docs/architecture.md](docs/architecture.md) | 分层与依赖方向 | | [docs/apps.md](docs/apps.md) | 应用与 `.app` 容器 | | [docs/spak-os.md](docs/spak-os.md) | Spak OS 桌面壳 | | [docs/mods](docs/mods) | 模组规范 | | [docs/extensions.md](docs/extensions.md) | 扩展系统 | | [docs/distribution.md](docs/distribution.md) | 分发与发布 | | [docs/security.md](docs/security.md) | 权限与安全模型 |
## 开发 ```bash pnpm install && pnpm build && pnpm test node scripts/os-acceptance.mjs # 需要 ws + chromium ``` ## 贡献 欢迎 issue 与 PR,提交前请确保 `pnpm build && pnpm test` 通过,详见 [CONTRIBUTING.md](CONTRIBUTING.md)。
MIT License · Copyright © Spak Team