npm - @akira-tl/forgerelay - Versions diffs - 0.10.5 → 1.0.0 - Mend

@akira-tl/forgerelay 0.10.5 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (4) hide show

package/CHANGELOG.md CHANGED Viewed

@@ -4,6 +4,13 @@ All notable ForgeRelay changes are documented here.
 ## [Unreleased]
+## [1.0.0] - 2026-09-07
+### Changed
+- Declared ForgeRelay 1.0 as the stable baseline for the current MCP, CLI, persistent Workspace, managed-worktree, Relay/Composite, Code Intelligence, Hook, Task, Activity/Audit, recovery/checkpoint, and native cross-platform Command Shell Runtime contracts.
+- Reworked the README and GitHub Wiki around first-run usage, added the ForgeRelay brand assets and Activity Panel preview, and kept upstream DevSpace provenance explicit through the existing MIT attribution and NOTICE.
 ## [0.10.5] - 2026-09-06
 ### Changed

package/README.md CHANGED Viewed

@@ -1,381 +1,252 @@
-# ForgeRelay
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="docs/assets/forgerelay-lockup-dark.png">
+    <img src="docs/assets/forgerelay-lockup-light.png" alt="ForgeRelay" width="620">
+  </picture>
+</p>
-**Give MCP coding agents a real local workspace.**
+<p align="center">
+  <strong>Use MCP coding agents on the projects and tools already on your machine.</strong><br>
+  <strong>让 MCP 编程 Agent 直接使用你电脑上现有的项目和开发工具。</strong>
+</p>
-[![npm](https://img.shields.io/npm/v/%40akira-tl%2Fforgerelay?style=flat-square)](https://www.npmjs.com/package/@akira-tl/forgerelay)
-[![Release](https://img.shields.io/github/actions/workflow/status/Akira-TL/forgerelay/release.yml?style=flat-square&label=release)](https://github.com/Akira-TL/forgerelay/actions/workflows/release.yml)
-[![License](https://img.shields.io/npm/l/%40akira-tl%2Fforgerelay?style=flat-square)](LICENSE)
+<p align="center">
+  <a href="#中文">中文</a> · <a href="#english">English</a>
+</p>
-ForgeRelay is a self-hosted MCP server that lets ChatGPT and other MCP-capable
-hosts work on the repositories already on your machine. The host gets explicit
-tools for files, shell commands, Git, managed worktrees, change review, and
-optional local-agent delegation. Your project stays in your normal development
-environment, with the same compilers, package managers, credentials, and Git
-installation you already use.
+<p align="center">
+  <a href="https://www.npmjs.com/package/@akira-tl/forgerelay"><img src="https://img.shields.io/npm/v/%40akira-tl%2Fforgerelay?style=flat-square" alt="npm"></a>
+  <a href="https://github.com/Akira-TL/forgerelay/actions/workflows/release.yml"><img src="https://img.shields.io/github/actions/workflow/status/Akira-TL/forgerelay/release.yml?style=flat-square&label=release" alt="Release"></a>
+  <a href="LICENSE"><img src="https://img.shields.io/npm/l/%40akira-tl%2Fforgerelay?style=flat-square" alt="License"></a>
+</p>
-It is not a model and it is not another coding-agent UI. ForgeRelay sits between
-the host and your local development tools and handles the parts that need to run
-on your machine.
+<p align="center">
+  <img src="docs/assets/forgerelay-ui-preview.png" alt="ForgeRelay Activity Panel" width="640">
+</p>
-> [!NOTE]
-> ForgeRelay is an independently maintained derivative of the MIT-licensed
-> [Waishnav/devspace](https://github.com/Waishnav/devspace) project. It is not an
-> official DevSpace release. The original copyright notice and license are kept
-> in [LICENSE](LICENSE), with additional provenance in [NOTICE.md](NOTICE.md).
+# 中文
-## Quick start
+ForgeRelay 是一个运行在你自己机器上的 MCP Server。它解决的是一个很实际的问题：ChatGPT 这类 Host 会写代码，但默认碰不到你电脑上的项目、Shell 和 Git。
-ForgeRelay requires Node `>=22.19 <27`, npm, Git, and a supported Command Shell Runtime. Bash is the primary POSIX compatibility target; zsh and POSIX sh can be selected explicitly. On Windows, PowerShell 7, Windows PowerShell 5.1, and cmd.exe are first-class native runtimes.
+把 ForgeRelay 接上以后，Agent 就能直接在你现有的仓库里改文件、跑测试和构建、执行 Git、调用语言服务器，并继续使用你已经装好的工具链。项目不用搬到另一套工作目录，也不用为了这件事再换一套 Coding Agent。
-Install it globally:
+## 安装
-```bash
-npm install -g @akira-tl/forgerelay
-```
-Then configure and start it:
+需要 Node.js `>=22.19 <27`、npm 和 Git。
 ```bash
+npm install -g @akira-tl/forgerelay
 forgerelay init
 forgerelay serve
 ```
-Or run it directly with `npx`:
+不想全局安装也可以：
 ```bash
 npx @akira-tl/forgerelay init
 npx @akira-tl/forgerelay serve
 ```
-The default local MCP endpoint is:
+默认 MCP 地址：
 ```text
 http://127.0.0.1:7676/mcp
 ```
-If the MCP host cannot reach localhost, put ForgeRelay behind a public HTTPS
-tunnel or reverse proxy such as Cloudflare Tunnel, ngrok, Pinggy, Tailscale
-Funnel, or your own proxy. Setup separates **Direct LAN** (`0.0.0.0`) from
-**HTTPS reverse proxy / tunnel** (`127.0.0.1` with loopback-only proxy trust), so
-you do not need to choose a bind address manually. During setup, enter the public
-base URL before the final `/mcp`; routed prefixes are allowed:
-```text
-https://your-tunnel-host.example.com/forgerelay/main
-```
+`forgerelay init` 会让你选择允许访问的项目目录，并生成 Owner password。第一次连接 MCP Host 时，用这个密码批准客户端。
-The client then connects to:
+检查当前实际生效的配置和 Shell：
-```text
-https://your-tunnel-host.example.com/forgerelay/main/mcp
+```bash
+forgerelay doctor
 ```
-`publicBaseUrl` may also be an ordered list when multiple public entries are
-valid; each entry may use its own route and the first is canonical for generated
-metadata/links. Every configured pathname is an accepted inbound operational route
-boundary. If the only configured route is `/forgerelay/main`, MCP/OAuth/health/App
-routes are served below that prefix rather than in parallel at naked `/mcp`,
-`/authorize`, or `/healthz` paths.
+### ChatGPT 访问不到 localhost？
+如果 Host 运行在云端，需要给 ForgeRelay 一个公网 HTTPS 入口。Cloudflare Tunnel、ngrok、Tailscale Funnel 或普通反向代理都可以。
-ForgeRelay uses an Owner-password OAuth approval flow. `forgerelay init` prints
-the password and stores it in the active config directory. New installations use:
+假设公网地址是：
 ```text
-~/.forgerelay/config.json
-~/.forgerelay/auth.json
+https://forge.example.com/forgerelay
 ```
-Keep `auth.json` private.
-## What it gives an MCP host
+那么 Host 连接：
-Once a workspace is open, the host can:
-- read, create, edit, and search files inside that workspace;
-- run your local tests, builds, package scripts, Git commands, and shell tools;
-- reuse the same workspace when the same checkout is opened again;
-- follow repository instructions from `AGENTS.md` and `CLAUDE.md`;
-- discover Agent Skills and configured local subagent profiles;
-- create a branch-backed Git worktree when you explicitly ask for isolated or
-  parallel work;
-- close a managed worktree by committing its remaining changes and
-  fast-forwarding the target branch when that can be done safely;
-- show aggregate changes through optional ChatGPT Apps-compatible UI cards;
-- run user-configured lifecycle hooks around tool calls, file changes, managed
-  worktree close, and local subagent execution.
-Normal work happens in your existing checkout. ForgeRelay does not silently move
-every task into a worktree.
+```text
+https://forge.example.com/forgerelay/mcp
+```
-## Composite workspaces across multiple devices
+`publicBaseUrl` 填到 `/mcp` 之前。更完整的 OAuth、Tunnel 和反向代理说明见 [快速开始](https://github.com/Akira-TL/forgerelay/wiki/Getting-Started)。
-When one task needs more than one execution environment, a Composite Workspace keeps
-one Host-facing working context while preserving each member Workspace as a separate
-execution boundary. For example, `code` can point at a local checkout while
-`compute` points through Workspace Relay at a GPU machine.
+## 用起来是什么样
-Composite Workspaces use the same lifecycle entry points as ordinary Workspaces:
+正常情况下，Agent 打开你现有的 checkout，然后直接在里面工作：
 ```text
-open_workspace({ kind: "composite", name: "research-project" })
-open_workspace({
-  action: "member",
-  workspaceId: "cws_...",
-  memberAction: "add",
-  member: {
-    name: "compute",
-    purpose: "GPU and high-performance computation",
-    path: "/srv/research",
-    relay: "gpu-server"
-  }
-})
+open_workspace(path="~/project")
 ```
-Work still names the member explicitly:
+之后它可以读取和修改文件，也可以运行真实命令：
 ```text
-read({ workspaceId: "cws_...", member: "code", path: "src/model.py" })
-bash({ workspaceId: "cws_...", member: "compute", command: "python train.py" })
+read(path="src/server.ts")
+bash(command="npm test")
+bash(command="git status --short")
 ```
-ForgeRelay does not merge member filesystems, Git state, Hooks, Skills, processes,
-shell/platform identity, privilege state, or audit facts, and it never infers a member from the tool type or purpose text. `memberContext.executionContext` reports the selected member's actual execution platform and Command Shell Runtime; it overrides the Gateway shell identity for commands routed to that member.
-The Composite Activity Panel presents member operations in one Host Turn while the
-actual facts remain owned by the member Workspace. `close_workspace` on a Composite
-Workspace now preserves the Composite identity and member topology as `closed`; a
-later `open_workspace` restores the same `cws_...` identity. `action="delete"` is the
-explicit dissolve operation. Neither close nor delete closes member Workspaces,
-finalizes their worktrees, stops their jobs, changes their files, or removes relay routes.
-### Progressive MCP context
-ForgeRelay keeps the callable MCP surface and its low-frequency operating manuals
-separate. `tools/list` remains the source of truth for tools the current server
-actually exposes. `open_workspace` returns a compact version/capability fingerprint
-and, on bootstrap, short descriptors for relevant ForgeRelay capability guides.
-The Agent can load a task-specific guide with `read` instead of receiving every
-Hook, worktree, subagent, artifact, OAuth, MCP App, PTY, and process edge case on
-every connection.
-The fingerprint also helps diagnose stale MCP Host metadata: if the running server
-reports a semantic capability but the Host still shows an older tool snapshot,
-refresh or reconnect the integration rather than assuming the capability is
-missing from ForgeRelay.
-## LSP code intelligence
-ForgeRelay 0.4 LSP v1 exposes semantic code navigation through the
-`code.intelligence` Capability without adding language-specific top-level MCP tools.
-The v1 operations are definition, hover/type information, references, document
-symbols, workspace symbols, and diagnostics. Results use ForgeRelay-owned normalized
-locations, ranges, symbols, hover content, and diagnostic shapes rather than raw LSP
-wire unions.
-Language servers are never installed automatically or without user authorization.
-ForgeRelay can discover configured or `PATH`-available servers, and `forgerelay init`
-can optionally enable Agent-managed installation of TypeScript/JavaScript and Pyright
-inside ForgeRelay's private config directory. That permission is disabled by default;
-a successful managed install becomes available to the same running ForgeRelay process
-on the next semantic request without a restart. `rust-analyzer`, `gopls`, and `clangd`
-remain external toolchain/system installations. See
-[Configuration Reference](docs/configuration.md#lsp-code-intelligence) and
-[`examples/language-servers.json`](examples/language-servers.json).
-## Worktrees without the usual cleanup mess
-A new managed worktree gets its own `forgerelay/*` branch instead of a detached
-HEAD. It remains visible from the source repository with ordinary Git commands:
+ForgeRelay 不会默认为每个任务创建 worktree。只有你明确要求隔离或并行开发时，才使用 managed worktree。
-```bash
-git worktree list
-git branch
-```
+长命令也不会要求 Agent 高频轮询。命令超过当前等待窗口时会返回稳定的 `processId`，后续继续等待或中断同一个进程即可。
-When `close_workspace` succeeds for a managed-worktree-backed workspace, ForgeRelay:
+## 主要能力
-1. checks that the source checkout is clean and still on the expected target branch;
-2. commits any remaining worktree changes;
-3. checks that the target can advance without a merge commit or conflict;
-4. fast-forwards the target branch;
-5. removes the worktree and the already-merged managed branch.
+- 文件、Shell、Git、测试、构建和项目脚本都在你的机器上运行。
+- Linux / macOS 可以用 Bash、zsh、POSIX sh；Windows 原生支持 PowerShell 7、Windows PowerShell 5.1 和 `cmd.exe`。
+- 同一个 checkout 会保留自己的 Workspace 身份。换一次对话，不需要重新创建工作区。
+- `code.intelligence` 可以查 definition、hover、references、symbols 和 diagnostics。
+- 项目里的 `AGENTS.md`、`CLAUDE.md` 和 Agent Skills 按需加载，不会每次都把整套说明重新塞进上下文。
+- 需要并行开发时可以创建真实 Git worktree；集成回主分支时只接受安全的 fast-forward，不自动制造 merge conflict。
+- Workspace Relay 可以把执行放到另一台 ForgeRelay；Composite Workspace 可以同时协调几个独立环境。
-If the histories have diverged, the close is refused and the worktree is left in
-place. ForgeRelay does not put the source checkout into a merge-conflict state.
-You can rebase and verify inside the worktree, then retry the close.
+Lifecycle Hooks、Workspace Tasks、本地 Subagent、Activity/Audit、Checkpoint 和 Recovery 也已经包含在项目里，但第一次安装时不需要先学这些。需要哪个，再去 [Wiki](https://github.com/Akira-TL/forgerelay/wiki) 查哪个。
-## Lifecycle hooks
+ForgeRelay 默认直接用现有 checkout。它不会偷偷创建 worktree、复制 Git ignored 文件、安装 Language Server，也不捆绑 Codex、Claude Code、Pi 之类的本地 Coding Agent runtime。
-Hook 是 ForgeRelay 的自动生命周期规则。首选方式是一个 Hook 一个文件：全局放在 `~/.forgerelay/hooks/<hook-name>.json`，项目放在 `<repo>/.forgerelay/hooks/<hook-name>.json`。文件名就是 Hook 名，方便直接从目录看出每条规则的用途；全局与项目规则组合执行，不需要额外批准。
+## 安全
-例如项目里的 `.forgerelay/hooks/release-tag-gate.json` 可以在稳定版本 tag push 前执行轻量发布门禁：
+ForgeRelay 给 Agent 的是真实本机执行权限，不是模拟环境。
-```json
-{
-  "event": "BeforeTool",
-  "matcher": {
-    "tool": "bash",
-    "commandRegex": "git\\s+push\\s+origin\\s+v\\d+\\.\\d+\\.\\d+"
-  },
-  "command": "node scripts/release-proof.mjs check-hook",
-  "timeoutSeconds": 30,
-  "report": true
-}
-```
+文件工具受 Workspace 和 allowed roots 限制；Shell 命令使用启动 ForgeRelay 的本地用户权限执行，**Shell 不是 OS sandbox**。因此只连接你信任的 MCP Host，只开放确实需要的项目目录，并保护好 Owner password。
-命中 `BeforeTool` 后，普通 tag push 的 Hook 只快速验证 clean working tree（含 untracked）、tag 与 package version 一致，以及本地 tag 指向当前 HEAD；成功才继续原始 `git push`，失败则直接阻断。force release-tag push 始终拒绝。对于失败发布后显式执行的 `git push --delete origin vX.Y.Z`，Hook 仅在当前 HEAD 有有效 `release:verify` proof，且联网确认 npm 对应版本与 GitHub Release 都不存在时允许删除；任一不可撤回产物存在或远端状态无法确认都会拒绝。因此仅有 tag 时可以重建同版本，一旦 GitHub Release 或包仓库版本存在就进入不可变状态。tag 推送后由 GitHub Actions 的 Linux/macOS/Windows 矩阵执行权威验证，全部通过后才进入发布。Hook 结果会回到 Agent，Agent 应向用户说明重要 Hook 是否通过或阻断了操作。`report:false` 可以隐藏不重要的成功报告，但阻断失败始终可见。
+ForgeRelay 默认拒绝 elevated / administrator 启动。只有你显式选择高权限运行时才会继续，并会提示系统级修改可能不可逆。
-旧的 inline `hooks` 和聚合 `hooks.json` 仍兼容；新配置建议都用独立 `hooks/*.json` 文件。
+完整边界见 [安全模型](https://github.com/Akira-TL/forgerelay/wiki/Security)。
-可以直接检查当前全局与项目规则，而不会执行 Hook：
+## 文档
-```bash
-forgerelay hooks list
-forgerelay hooks check
-forgerelay hooks list --project /path/to/project
-```
+- [快速开始](https://github.com/Akira-TL/forgerelay/wiki/Getting-Started)
+- [配置](https://github.com/Akira-TL/forgerelay/wiki/Configuration)
+- [安全模型](https://github.com/Akira-TL/forgerelay/wiki/Security)
+- [故障排查](https://github.com/Akira-TL/forgerelay/wiki/Troubleshooting)
+- [完整 Wiki](https://github.com/Akira-TL/forgerelay/wiki)
-`list` 展示实际加载的规则、matcher、timeout、report 与 command；`check` 只校验配置并在发现坏文件时返回非零状态。完整 matcher、事件与环境变量见 [Configuration Reference](docs/configuration.md#lifecycle-hooks)。
+> [!NOTE]
+> ForgeRelay 是基于 MIT License 的 [Waishnav/devspace](https://github.com/Waishnav/devspace) 独立衍生项目，不是官方 DevSpace Release。原始版权与 MIT License 保留在 [LICENSE](LICENSE)，来源与修改说明见 [NOTICE.md](NOTICE.md)。
-## Local coding agents
+---
-ForgeRelay can delegate work to local coding runtimes through user-defined
-profiles. The current adapter layer supports Codex, Claude, OpenCode, Pi,
-Cursor, and Copilot when the corresponding CLI is installed on the server.
-ForgeRelay does not install or bundle those coding runtimes.
+# English
-Profiles can live in:
+ForgeRelay is a self-hosted MCP server for a practical gap: hosts such as ChatGPT can write code, but they do not normally have access to the projects, shells, and Git repositories on your machine.
-```text
-~/.forgerelay/agents/*.md
-.forgerelay/agents/*.md
+Once ForgeRelay is connected, an Agent can edit the repository you already use, run tests and builds, execute Git, query language servers, and call your existing local toolchain. There is no separate project copy and no requirement to adopt another coding-agent runtime.
+## Install
+ForgeRelay requires Node.js `>=22.19 <27`, npm, and Git.
+```bash
+npm install -g @akira-tl/forgerelay
+forgerelay init
+forgerelay serve
 ```
-The current CLI workflow is:
+Or run it without a global install:
 ```bash
-forgerelay agents ls
-forgerelay agents run <profile-or-provider-or-id> "<prompt>"
-forgerelay agents show <id>
+npx @akira-tl/forgerelay init
+npx @akira-tl/forgerelay serve
 ```
-MCP hosts delegate through the `subagent.session` Capability Gateway; the CLI
-remains useful for local diagnostics and manual session inspection.
+The default MCP endpoint is:
-See [Agent Profile Schema](docs/agents/profile-schema.md) for the profile format.
+```text
+http://127.0.0.1:7676/mcp
+```
-## Configuration
+`forgerelay init` asks which project roots may be opened and generates an Owner password. Use that password to approve an MCP client on its first connection.
-Configuration uses the `FORGERELAY_*` prefix. For example:
+To see the configuration and Command Shell Runtime ForgeRelay actually resolved:
 ```bash
-FORGERELAY_ALLOWED_ROOTS="$HOME/projects" \
-FORGERELAY_PUBLIC_BASE_URL="https://forge.example.com" \
-forgerelay serve
+forgerelay doctor
 ```
-See [Configuration Reference](docs/configuration.md) for all supported options.
+### Host cannot reach localhost?
-## Security model
+Cloud-hosted MCP clients need a public HTTPS route to ForgeRelay. Cloudflare Tunnel, ngrok, Tailscale Funnel, or a normal reverse proxy all work.
+For a public base URL such as:
+```text
+https://forge.example.com/forgerelay
+```
-A connected MCP host can make real changes to local projects through ForgeRelay,
-using the same local account that runs the server. That trust boundary matters.
+the MCP client connects to:
-Filesystem tools enforce configured workspace and allowed-root boundaries. Shell
-commands are different: they run with the authority of your local user and are
-**not** contained by an operating-system sandbox added by ForgeRelay.
+```text
+https://forge.example.com/forgerelay/mcp
+```
-Only connect hosts you trust, keep the Owner password private, and expose only
-the project roots you actually want the host to use.
+Set `publicBaseUrl` before the final `/mcp`. See [Getting Started](https://github.com/Akira-TL/forgerelay/wiki/Getting-Started) for OAuth, tunnels, and reverse-proxy setup.
-See [Security Model](docs/security.md) for the full boundary and threat model.
+## What using it looks like
-## Platform support
+For normal work, an Agent opens the checkout you already have:
-| Platform | Status | Notes |
-| --- | --- | --- |
-| Linux | Supported | Bash is the primary POSIX compatibility target; zsh and POSIX sh are explicit native choices with shell-specific compatibility guidance. |
-| macOS | Supported | Bash is the primary POSIX compatibility target; zsh and POSIX sh are explicit native choices with shell-specific compatibility guidance. |
-| Windows with PowerShell 7 (`pwsh`) | Supported | Agent commands, Hooks, pipe/PTY execution, packaged launcher, and editable shell Instructions use one native `pwsh` runtime without loading the user profile. |
-| Windows with Windows PowerShell 5.1 (`powershell.exe`) | Supported | Agent commands, Hooks, pipe/PTY execution, packaged launcher, and editable shell Instructions use the selected 5.1 runtime with 5.1-specific syntax guidance. |
-| Windows with `cmd.exe` | Supported | Agent commands, Hooks, pipe/ConPTY execution, packaged `.cmd` launcher, and editable shell Instructions preserve cmd syntax and runtime identity. |
-| Windows with Git Bash, WSL, MSYS2, or Cygwin Bash | Compatibility path | Bash remains available when the selected executable provides the expected Bash command language. |
+```text
+open_workspace(path="~/project")
+```
-You can check the local runtime with:
+It can then work with files and run real local commands:
-```bash
-forgerelay doctor
+```text
+read(path="src/server.ts")
+bash(command="npm test")
+bash(command="git status --short")
 ```
-## Where ForgeRelay is going
+ForgeRelay does not create a worktree for every task. Managed worktrees are for cases where you explicitly want isolation or parallel development.
-With persistent Workspace lifecycle, first-class Subagent delegation, managed-LSP
-support, and worktree-close verification already shipped, the 0.9 line focuses on
-Workspace recovery and history without expanding the canonical Core tool surface:
+Long commands do not require tight polling either. Once the current wait window expires, ForgeRelay returns a stable `processId`; later calls wait on, interact with, or interrupt that same process.
-1. read-only managed-worktree recovery diagnostics, followed by safe repair/cleanup;
-2. persistent Workspace checkpoints and concurrency-safe restore;
-3. owner-facing retention inspection and explicitly authorized maintenance.
+## Highlights
-ForgeRelay does not plan to add its own shell sandbox, long-term memory system,
-or plugin marketplace. Conversation, planning, web access, and other host-native
-capabilities stay with the MCP host. Long-term context can be provided by a
-separate service instead of being mixed into the workspace runtime.
+- Files, shells, Git, tests, builds, and project scripts run on your machine.
+- Linux/macOS can use Bash, zsh, or POSIX sh. Windows has native PowerShell 7, Windows PowerShell 5.1, and `cmd.exe` support.
+- Reopening the same checkout reuses the same Workspace identity instead of creating another one for every conversation.
+- `code.intelligence` provides definition, hover, references, symbols, and diagnostics.
+- `AGENTS.md`, `CLAUDE.md`, and Agent Skills are loaded as needed instead of being resent in full on every open.
+- Managed worktrees provide real Git isolation when you ask for parallel work, with fast-forward-only finalization.
+- Workspace Relay runs work on another ForgeRelay instance; Composite Workspaces coordinate several independent environments from one Host.
-See [Roadmap](docs/roadmap.md) for the current plan.
+Lifecycle Hooks, Workspace Tasks, local Subagents, Activity/Audit, checkpoints, and recovery are included too. They are optional parts of the workflow; the [Wiki](https://github.com/Akira-TL/forgerelay/wiki) documents them when you need them.
-## Releases
+By default, ForgeRelay works in the checkout you already have. It does not silently create worktrees, copy Git-ignored files, install Language Servers, or bundle local coding runtimes such as Codex, Claude Code, or Pi.
-ForgeRelay uses standard SemVer, starting at `0.1.0`.
+## Security
-Prepare a release with:
+ForgeRelay gives an Agent real local execution capability.
-```bash
-npm run release:check
-npm run release:patch
-npm run release:minor
-npm run release:major
-```
+Filesystem tools are constrained by the opened Workspace and configured allowed roots. Shell commands run with the authority of the local user running ForgeRelay; **the shell is not an OS sandbox**. Connect only MCP hosts you trust, expose only project roots you want an Agent to access, and keep the Owner password private.
-Daily branch pushes do not run cloud CI. Commit the release-ready tree, push it to
-`main`, then push the matching `vX.Y.Z` tag. That tag is the only cloud CI and publish
-trigger: GitHub Actions runs the reusable Linux/macOS/Windows verification matrix,
-then publishes `@akira-tl/forgerelay` and creates the matching GitHub Release only
-after all platforms succeed. `npm run release:verify` remains available only when a
-cloud failure needs local reproduction against the pinned Node runtime; it is not a
-release prerequisite.
+Elevated / administrator startup is rejected by default. It only proceeds after explicit opt-in, with a warning that system-level AI-driven changes may be irreversible.
-See [Versioning and Release Management](docs/reference/versioning.md) for the bootstrap and
-Trusted Publishing setup.
+See the [Security model](https://github.com/Akira-TL/forgerelay/wiki/Security) for the full boundary.
 ## Documentation
-- [GitHub Wiki](https://github.com/Akira-TL/forgerelay/wiki) — 面向用户的使用指南、概念说明与故障排查入口。
-- [Setup Guide](docs/setup.md)
-- [Local Debugging and 7677 Acceptance](docs/debugging.md)
-- [ChatGPT Coding Workflow](docs/chatgpt-coding-workflow.md)
-- [Configuration Reference](docs/configuration.md)
-- [Agent Profile Schema](docs/agents/profile-schema.md)
-- [Native File Download](docs/reference/artifact-exchange.md)
-- [Security Model](docs/security.md)
-- [Troubleshooting](docs/gotchas.md)
-- [Roadmap](docs/roadmap.md)
-- [Versioning and Release Management](docs/reference/versioning.md)
-- [GitHub Wiki Maintenance](docs/maintenance/wiki.md)
-- [Changelog](CHANGELOG.md)
-- [Attribution Notice](NOTICE.md)
-## Upstream and attribution
-ForgeRelay is based on the original
-[Waishnav/devspace](https://github.com/Waishnav/devspace) project by Waishnav,
-released under the MIT License. ForgeRelay has its own name, package, release
-stream, runtime changes, and roadmap, but the upstream provenance remains part of
-the project.
-The original copyright notice remains in [LICENSE](LICENSE). See
-[NOTICE.md](NOTICE.md) for the attribution and modification notice.
-## Local development
+- [Getting Started](https://github.com/Akira-TL/forgerelay/wiki/Getting-Started)
+- [Configuration](https://github.com/Akira-TL/forgerelay/wiki/Configuration)
+- [Security model](https://github.com/Akira-TL/forgerelay/wiki/Security)
+- [Troubleshooting](https://github.com/Akira-TL/forgerelay/wiki/Troubleshooting)
+- [Full Wiki](https://github.com/Akira-TL/forgerelay/wiki)
+> [!NOTE]
+> ForgeRelay is an independently maintained derivative of the MIT-licensed [Waishnav/devspace](https://github.com/Waishnav/devspace) project. It is not an official DevSpace release. The original copyright and MIT License remain in [LICENSE](LICENSE); provenance and modification details are documented in [NOTICE.md](NOTICE.md).
+## Development
 ```bash
 npm install --include=dev
@@ -386,11 +257,4 @@ npm test
 npm run build
 ```
-`npm run dev` uses the checked-in local debug configuration and binds ForgeRelay
-to `127.0.0.1:7677`, keeping the normal `7676` product port free. The
-`debug:accept` command starts a temporary 7677 server and sends real
-HTTP/OAuth/MCP requests through it, including workspace tools, managed worktree
-close, and Hooks v1 lifecycle recording. Debug state stays under the gitignored
-`.forgerelay-debug/` directory.
-See [Local Debugging](docs/debugging.md) for the exact configuration and scripts.
+`npm run dev` uses the 7677 debug runtime. Product port 7676 is kept separate from development acceptance.

package/docs/roadmap.md CHANGED Viewed

@@ -348,10 +348,9 @@ recovery, checkpoint, and retention facts; the Gateway only routes and presents
 results. Development acceptance remains on isolated 7677/7678 instances and never uses
 the normal 7676 installation.
-Later refinements may add `.worktreeinclude`-style explicit copying of selected
-Git-ignored files. Native Windows Command Shell Runtime support was intentionally
-kept out of the 0.9 recovery/history line and was subsequently delivered across
-the 0.10.x P3 work for PowerShell 7, Windows PowerShell 5.1, and `cmd.exe`.
+Native Windows Command Shell Runtime support was intentionally kept out of the
+0.9 recovery/history line and was subsequently delivered across the 0.10.x P3
+work for PowerShell 7, Windows PowerShell 5.1, and `cmd.exe`.
 ## Workspace Task Lists

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@akira-tl/forgerelay",
-  "version": "0.10.5",
+  "version": "1.0.0",
   "description": "Local development control plane for MCP coding agents.",
   "type": "module",
   "homepage": "https://github.com/Akira-TL/forgerelay#readme",