# x-iztro 文档

- [文档](/zh/docs): 把出生时间算成一张完整的紫微斗数命盘，并一键转成大模型读得懂的文字。Rust 核心，供 Rust、Python、Go 调用。
- x-iztro: 紫微斗数排盘库，Rust 核心 + 三语言绑定
  - [介绍](/zh/docs/guide): 把出生时间算成一张完整的紫微斗数命盘，并一键转成大模型读得懂的文字。Rust 核心，供 Rust、Python、Go 调用，结果与 JS iztro 逐字段一致。

  - **上手**
  - 快速开始
    - [概览](/zh/docs/guide/getting-started): 排盘要准备哪些输入、每个参数取什么值，以及三种编程语言的安装方式。
    - [Rust](/zh/docs/guide/getting-started/rust): 安装 x-iztro crate，排出第一张盘，读懂枚举与翻译函数的分工。
    - [Python](/zh/docs/guide/getting-started/python): pip 安装，dataclass 类型化 API，用枚举做与语言无关的判断。
    - [Go](/zh/docs/guide/getting-started/go): go get 即用，内嵌 WebAssembly，无 cgo，保留交叉编译能力。

  - **紫微斗数**
  - 紫微斗数概念
    - [一张盘由什么构成](/zh/docs/guide/concepts): 紫微斗数的最小知识集，不懂代码也能读：一张盘是什么、由哪些部分组成、每一部分决定什么。
    - [干支与五行](/zh/docs/guide/concepts/stems-branches): 天干、地支、五行、阴阳各自决定排盘的哪一部分，宫干从哪来，命主身主怎么查。
    - [十二宫](/zh/docs/guide/concepts/palaces): 十二个宫名各自代表什么，身宫与来因宫的判定，宫干的用途，以及大限小限如何挂在宫上。
    - [星耀](/zh/docs/guide/concepts/stars): 三组星耀各自装什么，星耀分八类，亮度与四化标记怎么读，四组十二神是什么，以及星名对照表。
    - [四化与飞星](/zh/docs/guide/concepts/mutagen): 禄权科忌从哪来、十天干四化全表、自化与飞化怎么判断。
    - [三方四正](/zh/docs/guide/concepts/surrounded): 为什么一个宫不能单独看，三方四正由哪四个宫组成，以及在三种编程语言里怎么取。
    - [运限](/zh/docs/guide/concepts/horoscope): 六个时间层级各自算什么，同一格子的宫名为什么会变，童限怎么起，流耀与流年十二神从哪来。
    - [排盘是怎么算的](/zh/docs/guide/concepts/how-it-works): 从出生数据到一张完整命盘的九个步骤，每一步在做什么、依据是什么。

  - **使用指南**
  - 使用指南
    - [概览](/zh/docs/guide/guides): AI 解盘、配置与流派、跨语言判断、多种盘面语言输出、错误处理与扩展的使用指南。
    - [不写代码怎么用它](/zh/docs/guide/guides/for-non-developers): x-iztro 能做什么、典型用在哪、要跟工程师交代哪几件事，以及它准不准。
    - [AI Prompt 生成](/zh/docs/guide/guides/ai-prompt): 把一张盘或一段运限转成结构化文本，直接交给大模型分析。
    - [让 AI 解读命盘](/zh/docs/guide/guides/llm): 排盘交给库、解读交给模型：怎么把 x-iztro 接进 AI 应用，以及几条踩过的坑。
    - [Config 详解](/zh/docs/guide/guides/config): 六个开关分别改变什么、自定义四化表与亮度表怎么传、什么时候会看出差别。
    - [语言无关的 key 契约](/zh/docs/guide/guides/keys): 为什么星名不能拿来做判断，key 字段是什么，三种编程语言各自怎么用。
    - [多语言输出](/zh/docs/guide/guides/i18n): 六种盘面语言、哪些字段会被翻译、换盘面语言对结果的影响，以及标识与译名的双向换算。
    - [错误处理](/zh/docs/guide/guides/errors): 校验了什么、在哪一层校验、四个错误分类各是什么，以及为什么核心层坚持不 panic。
    - [扩展星盘](/zh/docs/guide/guides/plugins): 把自己的分析规则挂到星盘上——三种编程语言各自的扩展点。
    - [排盘九步对应的 API](/zh/docs/guide/guides/step-api): 排盘的九个步骤各自对应哪个公开函数，以及哪些步骤会被配置开关改变。
    - [给 AI 读的文档端点](/zh/docs/guide/guides/llms-txt): 本站提供的 llms.txt、llms-full.txt、单页 Markdown 与 Accept 头协商。

  - **数据结构**
  - [数据结构字典](/zh/docs/guide/data-model): Astrolabe、Palace、Star、Horoscope 每一个字段的类型与含义。

  - **关于**
  - 关于
    - [概览](/zh/docs/guide/about): 准确性保证、给 AI 读的文档端点，以及移植与架构说明。
    - [准确性保证](/zh/docs/guide/about/accuracy): 约 71 万例金标测试如何保证 x-iztro 与 JS iztro 零差异，以及这个「准」的边界在哪。
    - [架构](/zh/docs/guide/about/architecture): 核心层与三套绑定的分层、各自的实现取舍，以及不 panic 的设计约束。
    - [从 iztro 迁移：API 对照](/zh/docs/guide/about/iztro-parity): iztro 每个公开 API 在 x-iztro 三侧的落点，换了形状的几处及其原因，以及不提供的那些。
- Rust: Rust API 参考
  - [概览](/zh/docs/rust): crate 结构、类型体系与阅读本参考的方式。

  - **排盘**
  - [排盘入口](/zh/docs/rust/astro): by_solar、by_lunar、rearranged 与 JSON 便捷版本。
  - [星盘对象](/zh/docs/rust/astrolabe): Astrolabe 的字段、定位方法与三方四正判断。

  - **对象方法**
  - [宫位对象](/zh/docs/rust/palace): PalaceData 的字段，以及星耀判断、空宫判断与飞星族的全部方法。
  - [星耀对象](/zh/docs/rust/star-object): Star 的字段与亮度、四化判断，以及 StarRef 的回溯能力。
  - [三方四正](/zh/docs/rust/surpalaces): SurroundedPalaces 的四个宫位与五个判断方法。
  - [运限对象](/zh/docs/rust/horoscope): 六个运限层级的数据结构，以及不必再传星盘的宫位查询方法。

  - **模块函数**
  - [轻量查询](/zh/docs/rust/query): 不排整盘就能拿到的生肖、星座与命宫主星。
  - [工具函数](/zh/docs/rust/util): 索引换算、亮度与四化查表、命身宫推算、四柱展示串。
  - [安星模块](/zh/docs/rust/star): 按出生数据取某一组星耀的落宫，以及排盘流水线的低层构件。
  - [数据表](/zh/docs/rust/data): 枚举与它们的方法、排盘配置、星耀基础信息、天干地支信息与顺序常量。
  - [翻译](/zh/docs/rust/i18n): 标识与译名的双向查找，以及按类目的翻译函数。

  - **进阶**
  - [扩展星盘](/zh/docs/rust/extend): 用扩展 trait 给 Astrolabe、PalaceRef 补自定义分析方法。
  - [错误处理](/zh/docs/rust/errors): IztroError 的三个变体、code() 分类标识、BridgeError 与排查方式。
- Python: Python API 参考
  - [概览](/zh/docs/python): 包结构、类型体系与阅读本参考的方式。

  - **排盘**
  - [排盘入口](/zh/docs/python/astro): Astro 类的排盘方法、重排与 AI Prompt 生成。
  - [星盘对象](/zh/docs/python/astrolabe): Astrolabe 的字段、定位方法与三方四正判断。

  - **对象方法**
  - [宫位对象](/zh/docs/python/palace): Palace 的字段，以及星耀判断、空宫判断与飞星族的全部方法。
  - [星耀对象](/zh/docs/python/star-object): Star 的字段与亮度、四化判断，以及回溯所在宫的能力。
  - [三方四正](/zh/docs/python/surpalaces): SurroundedPalaces 的四个宫位与五个判断方法。
  - [运限对象](/zh/docs/python/horoscope): 六个运限层级的数据结构，以及不必再传星盘的宫位查询方法。

  - **模块函数**
  - [轻量查询](/zh/docs/python/query): 不排整盘就能拿到的生肖、星座与命宫主星。
  - [工具函数](/zh/docs/python/util): 索引换算、亮度与四化查表、命身宫推算、大限小限、四柱展示串。
  - [安星模块](/zh/docs/python/star): 按出生数据取某一组星耀的落宫。
  - [数据表](/zh/docs/python/data): 星耀基础信息、天干地支信息、顺序常量与全部枚举。
  - [翻译](/zh/docs/python/i18n): 标识与译名的双向查找。

  - **进阶**
  - [扩展星盘](/zh/docs/python/extend): 用插件给 Astrolabe 类挂自定义分析方法。
  - [错误处理](/zh/docs/python/errors): IztroError 的 code 分类、触发条件、消息格式与处理模式。
- Go: Go API 参考
  - [概览](/zh/docs/go): 包结构、类型体系与阅读本参考的方式。

  - **排盘**
  - [排盘入口](/zh/docs/go/astro): BySolar、ByLunar、Rearranged 与 AI Prompt 生成。
  - [星盘对象](/zh/docs/go/astrolabe): Astrolabe 的字段、定位方法与三方四正判断。

  - **对象方法**
  - [宫位对象](/zh/docs/go/palace): Palace 的字段，以及星耀判断、空宫判断与飞星族的全部方法。
  - [星耀对象](/zh/docs/go/star-object): Star 的字段与亮度、四化判断，以及回溯所在宫的能力。
  - [三方四正](/zh/docs/go/surpalaces): SurroundedPalaces 的四个宫位与五个判断方法。
  - [运限对象](/zh/docs/go/horoscope): 六个运限层级的数据结构，以及不必再传星盘的宫位查询方法。

  - **模块函数**
  - [轻量查询](/zh/docs/go/query): 不排整盘就能拿到的生肖、星座与命宫主星。
  - [工具函数](/zh/docs/go/util): 索引换算、亮度与四化查表、命身宫推算、大限小限、四柱展示串。
  - [安星模块](/zh/docs/go/star): 按出生数据取某一组星耀的落宫。
  - [数据表](/zh/docs/go/data): 星耀基础信息、天干地支信息、顺序常量与全部标识常量。
  - [翻译](/zh/docs/go/i18n): 标识与译名的双向查找。

  - **进阶**
  - [扩展星盘](/zh/docs/go/extend): 用结构体嵌入给星盘补自定义分析方法。
  - [错误处理](/zh/docs/go/errors): *Error 的 Code 分类、四个哨兵、触发条件与处理模式。

## Full text and other languages

- [中文全文 (Chinese full text)](/zh/llms-full.txt)
- [English index](/en/llms.txt)
- [English full text](/en/llms-full.txt)