@olierjs/fugue-cli 0.0.0-stage → 0.1.2

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,100 @@
-# Temporary Holding Version
+# Fugue CLI
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+`fugue-cli` 是 Fugue Stack 的统一入口，通过 npm 包 `@olierjs/fugue-cli` 分发。Go 命令使用 Cobra 构建，当前业务子命令只有 `guide`。
+
+## 安装与更新
+
+需要 Node >=22.19.0。安装时使用包内的预编译二进制，不需要本机安装 Go。
+
+```sh
+npm install -g @olierjs/fugue-cli@latest
+fugue-cli guide
+```
+
+后续更新执行同一条安装命令。包内提供 macOS、Linux、Windows 的 x64 和 arm64 二进制。
+
+使用 nvm 管理 Node 时，先在当前终端执行 `nvm use 22.19.0` 或选择更高版本，再安装和运行。启动 Agent 的环境也需要能通过 `PATH` 找到 `fugue-cli`。
+
+安装脚本自动将包内 Skill 同步到 `~/.agents/skills`，包括薄入口 `fugue-stack`、远端规划 `plan-with-remote`、原版 `show-me`、原版 `statechart` 和可视化解释适配 `fugue-show-me`。无需手动复制目录。替换同名旧 Skill 或清理本工具管理的过时 Skill 前，会先保存备份；其他 Skill 保持原样。备份放在 `~/.local/share/fugue-cli/backups`，位于技能发现目录之外。
+
+自动同步通过 npm 的 `postinstall` 执行，需要允许安装脚本运行。清理发生在安装或升级时，针对新版已移除的受管理 Skill；`npm uninstall` 没有对应的自动清理钩子。
+
+## 使用
+
+在 Agent 中调用 `$fugue-stack`，入口会要求执行 `fugue-cli guide`，读取当前安装版本的指南。也可以直接运行：
+
+```sh
+fugue-cli guide
+fugue-cli --help
+fugue-cli --version
+```
+
+在目标项目中启动支持 Skill 的 Agent，描述要完成的工作，例如：
+
+```text
+$fugue-stack 根据这份已确认需求实现功能，完成后审查差异并验证。
+$fugue-stack 审查当前代码变更，列出有实际影响的问题。
+$fugue-show-me 用最小的结构图解释这次改动。
+$fugue-show-me 检查取消与重试交错时的状态变化，画出可能的缺陷路径。
+```
+
+`fugue-cli guide` 输出工作指南，编码、审查和解释由当前 Agent 按指南执行。若安装后暂时看不到新 Skill，可重新启动 Agent 后再选择入口。
+
+需求理解、规划和需求或方案解释继续由 `plan-with-remote` 及远端规划服务负责。指南提供规划技能的绝对路径；该技能的客户端需要 Git、已配置的规划服务，以及已在服务中登记的目标仓库，配置说明见 [configuration.md](skills/plan-with-remote/references/configuration.md)。
+
+编码、代码审查与验证、面向人的实现解释由当前 Agent 按指南完成。读取指南本身不会发起规划、修改项目或调用模型。远端规划返回的正式文档继续按 Markdown 原文保存，批准版本由规划客户端和服务端管理。
+
+## 上游技能
+
+`show-me` 完整目录原样引入自 [humanlayer/skills](https://github.com/humanlayer/skills/tree/653b6411c1f70c275a18e37673b042ff99f67ceb/plugins/show-me/skills/show-me)，保留原始说明和 Agent 调用配置。来源、固定提交和目录记录在 [upstream-skills.json](upstream-skills.json)，MIT 许可保留在 [THIRD_PARTY_NOTICES](THIRD_PARTY_NOTICES)。
+
+`statechart` 完整目录原样引入自 [cursor/plugins 的 pstack](https://github.com/cursor/plugins/tree/99b609a72323b70204eab407c622f436e858e112/pstack/skills/statechart)，包括原始说明、脚本和测试。同样在来源记录中固定提交，并保留 MIT 许可。
+
+需要可视化解释时，总览路由到 [fugue-show-me](skills/fugue-show-me/SKILL.md)：由 `show-me` 选择通用表达形式，需要分析状态变化、检查行为规则或展示缺陷路径时配合 `statechart`。适配维护在独立目录中；更新上游时整体替换原版目录并更新来源记录。
+
+## 状态图依赖
+
+`statechart` 使用 Node.js 和 npm；模型检查还需要 [mise](https://mise.jdx.dev/getting-started.html)。macOS 可先安装：
+
+```sh
+brew install mise
+node ~/.agents/skills/statechart/scripts/statechart.mjs --help
+```
+
+首次模型检查由原版脚本通过 mise 安装 Java Temurin 25 和 TLC 1.7.4，需要联网下载约 305 MB。若使用已有环境，可按上游帮助设置 `JAVA` 和 `TLA2TOOLS`。首次 PNG 出图会将 `pele@1.8.0` 和 `@resvg/resvg-js@2.6.2` 安装到用户缓存目录；仅渲染现成 Mermaid 图时不运行 TLC。
+
+该版 TLC 无法解析模型字符串中的中文。模型使用 ASCII 标识符和字符串值，中文标签放在映射文件中，从模型生成中文状态图。
+
+输入和产物放在目标仓库之外的临时目录，按上游要求交付 PNG、Mermaid 源码、缺陷说明和再生成命令。模型检查结果与真实代码复现结果分别说明。
+
+## 开发与发布
+
+开发与打包需要 Go >=1.23 和 Node >=22.19.0。
+
+验证尚未发布到 npm 的仓库版本时，在仓库根目录打包，再安装生成的本地包：
+
+```sh
+npm pack
+npm install -g ./olierjs-fugue-cli-0.1.2.tgz
+fugue-cli --version
+fugue-cli guide
+```
+
+本地包安装同样会运行 Skill 自动同步。`@latest` 使用 npm 上的已发布版本，本地包使用本次构建的仓库版本。
+
+```sh
+go test ./...
+node --test tests/*.test.mjs
+node --test skills/statechart/scripts/test/statechart.test.mjs
+npm pack
+```
+
+上游测试包含 Linux 的 `LD_PRELOAD` 故障注入，并对临时路径和英文 Java 诊断文本作精确断言；macOS 上需单独核对这些环境差异。
+
+`npm pack` 的 `prepack` 自动构建各平台二进制，并将版本写入命令。发布目标固定为 npmjs，包名为 `@olierjs/fugue-cli`。发布验收后的包：
+
+```sh
+npm publish ./olierjs-fugue-cli-0.1.2.tgz --access public
+```
+
+Go 命令入口位于 [cmd/fugue-cli](cmd/fugue-cli/main.go)，指南源码位于 [guide.md](internal/cli/guide.md)，入口技能位于 [SKILL.md](skills/fugue-stack/SKILL.md)。