openrod 0.0.0-stage → 0.1.0-rc.1

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/NOTICE

@@ -0,0 +1,8 @@
+OpenRod
+Copyright 2026 The OpenRod authors
+
+This product includes software developed by NVIDIA CORPORATION & AFFILIATES
+as part of NVIDIA OpenShell (https://github.com/NVIDIA/OpenShell), licensed
+under the Apache License, Version 2.0. See vendor/OPENSHELL-LICENSE.
+
+Third-party software notices are in THIRD_PARTY_NOTICES.md.

package/README.md

@@ -1,3 +1,59 @@
-# Temporary Holding Version
+# OpenRod
 
-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.
+A web console for [NVIDIA OpenShell](https://github.com/NVIDIA/OpenShell). Create sandboxes, edit network policy, and open agent sessions from one place, running on your own machine.
+
+## You'll need
+
+- Node.js 22.13 or newer
+- macOS (Apple Silicon) or Linux
+- [OpenShell](https://github.com/NVIDIA/OpenShell) 0.1.2 with a local gateway
+- OpenSSH and OpenSSL
+
+Install OpenShell, pinned to the supported release:
+
+```bash
+curl -LsSf https://raw.githubusercontent.com/NVIDIA/OpenShell/main/install.sh | OPENSHELL_VERSION=v0.1.2 sh
+```
+
+## Run
+
+```bash
+npx openrod --open
+
+# or install the openrod command globally
+npm install -g openrod
+openrod --open
+```
+
+On every start, OpenRod prints a link with a new secret token. Open that link:
+
+```text
+OpenRod console (open this link): http://127.0.0.1:4600/?token=<secret>
+```
+
+Treat the link like a password: anyone who has it while OpenRod is running can use your gateway credentials. Then go to **Sandboxes → New sandbox → This computer** to connect your gateway.
+
+### Options
+
+```text
+--port <port>  HTTP port from 1 to 65535 (default: 4600)
+--host <host>  Loopback only: 127.0.0.1 (default), localhost, or ::1
+--open         Open the console in your default browser
+--no-open      Do not open a browser (default)
+--help, -h     Show help
+--version, -v  Show the installed version
+```
+
+If `openshell` isn't on your `PATH`, set `OPENSHELL_BIN` to its full path.
+
+## Docs
+
+- [README and quick start](https://github.com/OpenRod/OpenRod#readme)
+- [Opening sandboxes](https://github.com/OpenRod/OpenRod/blob/main/docs/opening-sandboxes.md) · [Remote SSH hosts](https://github.com/OpenRod/OpenRod/blob/main/docs/remote-hosts.md) · [What gets saved](https://github.com/OpenRod/OpenRod/blob/main/docs/data-and-state.md)
+- [Security](https://github.com/OpenRod/OpenRod/blob/main/SECURITY.md) · [Changelog](https://github.com/OpenRod/OpenRod/blob/main/CHANGELOG.md) · [Issues](https://github.com/OpenRod/OpenRod/issues)
+
+## License
+
+[Apache-2.0](https://github.com/OpenRod/OpenRod/blob/main/LICENSE) · Third-party notices in [THIRD_PARTY_NOTICES.md](https://github.com/OpenRod/OpenRod/blob/main/ui/THIRD_PARTY_NOTICES.md)
+
+OpenRod is an independent community project, not affiliated with, endorsed by, or supported by NVIDIA. NVIDIA and OpenShell are trademarks of NVIDIA Corporation.

package/SETUPS.md

@@ -0,0 +1,75 @@
+# MCP and Skills Setups
+
+## Workflow
+
+1. In **Setups → Bring my setup**, select MCPs and Skills from local harness configuration. Each category supports bulk selection.
+2. Quick setup and the image-template builder automatically prepare supported npm packages, then bake a pinned snapshot into the image. In Templates, select the Setup and choose Build template (or Save template for an existing image); preparation progress and cancellation appear in the editor. No separate install step is required. Credentials and unsupported launchers still need attention. For manual preparation or an existing sandbox, **Prepare & check** installs supported npm launchers in disposable OpenShell sandboxes, pins their dependencies, and checks MCP initialization without calling tools. A package that was prepared and passed that check is reused on later imports, retries and Quick setups with the same name, version, integrity hash and arguments; its stored archive digest is re-verified, and the registry policy check and version lookup still run first.
+3. Import saves the snapshot automatically and creates or updates the Setup's egress policy (see **Network access**); a popup lists the websites it allows. The dialog lists, before Import, the items that will be saved as inactive (for example unsupported launchers or missing credentials); compatible items can still be used. Import stops for review only when preparation finds a new problem.
+4. Select the Setup during Quick setup or template-based sandbox creation, or enable it on an existing sandbox. Quick setup shows package-build progress, stops creation on package failure, supports cancellation, and reuses the prepared snapshot/image on later launches. Destinations covered by the Setup's egress policy need no approval; credential-bound destinations and Setups saved before egress policies existed still list per-sandbox grants to approve. Image templates retain the Setup revision and package artifacts without credentials or active agent configuration.
+5. For account-based MCPs, authenticate in the sandbox's agent session. Codex has a **Sign in** action that opens its native MCP login in the terminal. Follow the authorization link and paste the callback URL when prompted. The harness owns its OAuth session and refresh lifecycle.
+
+## Security boundaries
+
+- Desktop OAuth sessions are not copied. Static secrets are transferred only with explicit selection or entry, stored as gateway credentials, and referenced by destination-bound policy rules.
+- Imported code runs inside a sandbox. npm lifecycle scripts are disabled. Dependency locks and artifact digests are checked; archives reject traversal and escaping links.
+- Runtime, package-build and authentication destinations are separate requirements. Organization restrictions and authoritative gateway policy remain in force. Unknown runtime destinations stay blocked.
+- Grants identify the actual executable. Interpreter permissions also apply to other code using that interpreter; they are not per-process isolation.
+- MCP initialization and tool discovery do not verify every tool action. Native OAuth completion is verified through the agent, not by reading its private tokens. Remote MCPs that publish OAuth sign-in metadata (read-only, policy-checked GETs from the console) are not started in a check sandbox at import; sign-in and the first connection happen through the agent in the destination sandbox.
+- Enabling checks the reviewed revision, executable identity and effective policy again. Installation preserves unrelated harness configuration. Removing a Setup removes managed files and takes the sandbox out of the Setup's egress policy; approved per-sandbox grants and gateway secrets require separate review/removal.
+
+## Network access
+
+Each saved Setup whose MCPs reach the network gets one managed allow policy, `policies/egress/setup-<setup id>.json`, named "MCPs & Skills: <setup name>" and shown in **Egress**.
+
+- It lists the hosts the Setup's active MCPs reach at runtime and each remote MCP's own sign-in host, on their ports (normally 443). Package-build hosts such as the npm registry are never included; only the isolated builder reaches them. Hosts the organization blocks are left out and reported in the import popup.
+- Hosts an MCP sends credentials to, and sign-in services named by an MCP's sign-in metadata, are not in the policy: each sandbox approves them when the Setup is enabled there. The import popup lists them.
+- It applies to the sandboxes that use the Setup (`appliesTo.setups`), not to everyone. Gateway labels are fixed at creation, so the console records membership in `setup-members.json` in the gateway/workspace's scoped state directory: at sandbox creation (selected and template Setups), on enable, on remove and on sandbox deletion. A Quick-setup `(prepared)` snapshot is recorded with the Setup it was prepared from and uses that Setup's policy. The policy is in the sandbox's policy from creation, and the 15-second policy sync keeps it current.
+- Hosts and ports added to the policy in Egress are kept when the Setup's hosts are recomputed (on import and when an item is deleted); ports only a removed MCP needed close. A policy switched to Block in Egress is left unchanged. The policy is removed when the Setup is deleted, or when it would have no hosts left.
+- A program inside a member sandbox can reach the listed hosts, as with any allow policy. Credential-bound destinations still use per-sandbox grants that inject the secret for the listed executable only.
+
+## Current limits
+
+- Supported package adapters cover npm/npx launchers. Python/uvx, arbitrary local projects and desktop-only integrations need additional adapters. Host application integrations cannot be made portable just by signing in.
+- Existing sandboxes need Python 3.11+, a compatible Node runtime and the selected harness. Package artifacts currently target Linux with glibc and the builder's architecture/Node major.
+- Skills are copied as reviewed files. Their instructions are not executed during import; arbitrary package, filesystem and network dependencies are not automatically inferred.
+- One Setup holds up to 64 MB of selected MCPs and Skills (each skill up to 4 MB and 200 files). Import the rest as a second Setup.
+- To use another registry or sign-in service, add it to the Setup's egress policy in Network › Egress. A completed sign-in does not override network or tool policy.
+- Preparation artifacts survive console restart. An interrupted import needs a fresh review. Failed enable operations may leave explicitly approved network rules or credential attachments in place, but take the sandbox back out of a Setup egress policy it had just joined; configuration checks report the failure.
+- Preparation checks npm connectivity inside the builder before installing packages. Each npm phase has a two-minute limit and the installation has a 250-second deadline; npm may retry individual downloads, but the console does not repeat the whole installation. Gateway startup, registry outages and interrupted gateway execution stop the remaining tools and retain completed items for review and retry. These rules apply to every import, Quick setup and template preparation.
+- The console cannot repair the gateway host's network routing or bootstrap image access. A local gateway image override does not change other users' gateways. The gateway must be able to start its builder and reach the approved registries; the importer reports that failure without bypassing policy or running imported code on the host.
+
+## Verification
+
+From `ui/`: `npm test` runs the automated tests and `npm run build` builds the production frontend. Live checks in disposable sandboxes have covered Quick setup from an unprepared npm MCP to a baked image and a working sandbox, MCP initialization and tool discovery, package install and removal, gateway credential substitution, and denial of an unrelated destination. Native OAuth logins reach the authorization step; account authorization is completed by the user. No MCP tool actions are invoked by these checks.
+
+## Destination agents
+
+The import source does not constrain the destination. `shared/setup-targets.json` is the common catalog for creation, installation, and live inventory. Setups imported from Codex, Claude Code, or Cursor can be installed for:
+
+| Agent | MCP configuration | Skill directory |
+| --- | --- | --- |
+| Claude Code | `~/.claude.json` | `~/.claude/skills/` |
+| Codex | `~/.codex/config.toml` | `~/.agents/skills/` |
+| Cursor | `~/.cursor/mcp.json` | `~/.cursor/skills/` |
+| OpenCode | `~/.config/opencode/opencode.json` (or existing `.jsonc`) | `~/.config/opencode/skills/` |
+| Pi | `~/.pi/agent/mcp.json` | `~/.pi/agent/skills/` |
+| Antigravity CLI | `~/.gemini/config/mcp_config.json` | `~/.gemini/config/skills/` |
+| GitHub Copilot | `~/.copilot/mcp-config.json` | `~/.copilot/skills/` |
+| Kiro CLI | `~/.kiro/settings/mcp.json` | `~/.kiro/skills/` |
+| Factory Droid | `~/.factory/mcp.json` | `~/.factory/skills/` |
+
+Aider is explicitly unavailable for Setup installation; this console does not provide a native MCP/skill adapter for it. It can still be selected as a sandbox agent. Import discovery still covers the original three local sources.
+
+MCP entries are converted to the destination schema (including OpenCode command arrays and `environment`, Copilot transport and tool discovery fields, Droid transport types, and Antigravity's `serverUrl`). Existing non-managed settings are preserved. OpenCode JSONC comments are accepted, though a managed update serializes that file as JSON. User changes to managed MCP values or skill files still block overwrite/removal.
+
+Agent versions must support the documented interfaces. In particular, Pi requires its built-in MCP client, and an extension registering `/mcp` may replace that client. Valid skill frontmatter and runtime dependencies remain the skill author's responsibility. Authentication stays inside each destination agent; source OAuth sessions are not transferred.
+
+Adapter references checked October 1, 2026:
+- [Pi MCP](https://pi.dev/docs/latest/mcp) and [skills](https://pi.dev/docs/latest/skills)
+- [OpenCode MCP](https://opencode.ai/docs/mcp-servers/) and [skills](https://opencode.ai/docs/skills/)
+- [Copilot MCP](https://docs.github.com/en/copilot/how-tos/copilot-cli/customize-copilot/add-mcp-servers) and [configuration paths](https://docs.github.com/en/copilot/reference/copilot-cli-reference/cli-config-dir-reference)
+- [Kiro configuration scopes](https://kiro.dev/docs/cli/chat/configuration/) and [MCP schema](https://kiro.dev/docs/mcp/configuration/)
+- [Droid MCP](https://docs.factory.ai/harness/mcp) and [configuration scopes](https://docs.factory.ai/enterprise/hierarchical-settings-and-org-control)
+- [Antigravity MCP migration](https://www.antigravity.google/docs/cli/gcli-migration/) and [skills](https://www.antigravity.google/docs/skills)
+
+Adapter lifecycle tests use isolated homes and stub agent executables; they verify file formats, settings preservation, conflict handling, removal, and inventory without invoking models. A disposable Linux container additionally verified Pi 0.99.2 and OpenCode 1.18.34 connecting to a local test MCP; both agents' native skill loaders found the installed test skill. Other newly added agents have not had authenticated live-session verification.