# locus-scope

**Repository Path**: CZXyee/locus-scope

## Basic Information

- **Project Name**: locus-scope
- **Description**: 可组合 Entity 图的 Scope 协议及轻量工具，定义了身份、关系、作用域和组合方式。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-09-03
- **Last Updated**: 2026-10-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# locus-scope

[![npm version](https://img.shields.io/npm/v/%40sundw%2Flocus-scope?logo=npm)](https://www.npmjs.com/package/@sundw/locus-scope)

[中文](README_CN.md) | [English](README.md)

可组合 Entity 图的 Scope 协议及轻量工具，定义身份、关系、作用域和组合方式。

Locus Scope 将具有身份的事物及其关系组织成有边界的图。Entity 可以表示环境、资源、能力、代码、知识、逻辑结构或其他领域对象；Scope 提供 ownership、命名、可见性与组合边界。一个可分发的 npm Package 对应一个 Scope。

## 使用

以 npm Package 提供 `locus-scope` 命令和 library API；也可单独使用 `@sundw/locus-scope-core` 提供 library API。

| Package                                                                | 使用场景                       |
| ---------------------------------------------------------------------- | ------------------------------ |
| [@sundw/locus-scope](packaging/npm/locus-scope/README_CN.md)           | CLI 命令及现有 library 入口。  |
| [@sundw/locus-scope-core](packaging/npm/locus-scope-core/README_CN.md) | Node.js/ library API，无 CLI。 |

从创建第一个 Scope 开始，请阅读[基本使用](documents/1-基本使用.md)。

Agent 可使用 CLI 工作流 Skill：

| CLI 工作流                                                    |
| ------------------------------------------------------------- |
| [`$use-locus-scope`](.agents/skills/use-locus-scope/SKILL.md) |

<details>
<summary>从源码构建</summary>
要求使用根 `package.json` 声明的 Node.js LTS 版本，以及其中固定的 pnpm：

```powershell
pnpm install --frozen-lockfile
pnpm run typecheck
pnpm run build
pnpm run release:npm
```

</details>

## 文档

- [基本使用](documents/1-基本使用.md)：创建、检查、组合和查询 Scope。
- [使用 npm](documents/2-使用npm.md)：安装统一 CLI，由 npm 或 pnpm 管理 Package。
- [CLI 参考](documents/3-CLI参考.md)：Workspace 查询、图操作、diff、mutation、输出和退出状态。
- [核心 API 参考](documents/4-核心API参考.md)：进程内 Workspace 加载、查询、图操作、diff、mutation 和结构化错误。

## License

[MIT](LICENSE)