open-agent-relay 0.1.0__tar.gz

open_agent_relay-0.1.0/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.

open_agent_relay-0.1.0/PKG-INFO

@@ -0,0 +1,314 @@
+Metadata-Version: 2.4
+Name: open-agent-relay
+Version: 0.1.0
+Summary: Let teammates call your local agent or automation directly over the LAN.
+Author: ShakespeareLabs
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/ShakespeareLabs/open-agent-relay
+Project-URL: Repository, https://github.com/ShakespeareLabs/open-agent-relay
+Project-URL: Issues, https://github.com/ShakespeareLabs/open-agent-relay/issues
+Project-URL: Documentation, https://github.com/ShakespeareLabs/open-agent-relay#readme
+Keywords: agents,automation,lan,local-first,self-hosted
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: System :: Distributed Computing
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# OpenAgentRelay
+
+[English](README.md) | [简体中文](README.zh-CN.md)
+
+> **Turn any local agent or automation into a team-callable capability.**
+
+OpenAgentRelay lets a teammate or another Agent call something that already works on your computer. They install one small `relay` CLI; they do not need this repository, your Agent source code, its dependencies, prompts, or business credentials.
+
+The `main` branch is an **Alpha for direct calls on a trusted LAN**. It uses plain HTTP and a shared key. Do not expose it to the public internet or connect it to production write operations.
+
+```text
+Caller or caller Agent  ── trusted LAN ──>  Publisher's relay  ──>  Local Agent
+          ↑                                                            |
+          └──────────────────────── result ─────────────────────────────┘
+```
+
+## Do not know how to use it? Send this link to your Agent
+
+Send this project link directly to Codex, Claude Code, or another Agent that can read web pages:
+
+```text
+https://github.com/ShakespeareLabs/open-agent-relay
+```
+
+Then tell the Agent which role you need. It can read this README, install the `relay` CLI without cloning the repository, and guide or perform the setup.
+
+For a publisher, copy this message:
+
+```text
+Read https://github.com/ShakespeareLabs/open-agent-relay and help me publish
+one existing local Agent as a trusted-LAN capability. Install only the relay CLI;
+do not clone the repository. Start with the safe test, use a restricted workspace
+and minimum credentials, then give me the Relay URL, Agent name, and the exact
+connection block I should share. Stop and ask me before any security-sensitive choice.
+```
+
+For a caller, send the connection details privately and copy this message:
+
+```text
+Read https://github.com/ShakespeareLabs/open-agent-relay and help me call a shared
+capability. Install only the relay CLI; do not clone the repository. Use --expect-agent
+and --json, treat a nonzero exit code as failure, and never print the Access Key.
+
+Relay URL: <URL from the publisher>
+Agent name: <name from the publisher>
+```
+
+Provide the Access Key through `RELAY_ACCESS_KEY`, not inside the message. The Agent needs this link plus the private connection details; it does not need OpenAgentRelay source code.
+
+## Install the CLI
+
+Normal users do not need to clone the repository. Install the CLI with [`pipx`](https://pipx.pypa.io/):
+
+```bash
+pipx install "git+https://github.com/ShakespeareLabs/open-agent-relay.git@main"
+relay version
+```
+
+If `pipx` is not installed, follow its one-time installation guide (`brew install pipx` on macOS is the common path).
+
+If you are already inside a Python 3.11+ virtual environment, use:
+
+```bash
+python -m pip install "git+https://github.com/ShakespeareLabs/open-agent-relay.git@main"
+```
+
+Cloning the repository is only needed for development. After the first packaged release, the primary installation command will become `pipx install open-agent-relay`.
+
+## End-to-end examples
+
+The [`examples/`](examples/) directory contains three reusable paths:
+
+- a zero-dependency, read-only report over local CSV data;
+- an ephemeral Codex review in a dedicated read-only workspace;
+- a Claude Code review using non-interactive plan mode with write and web tools blocked.
+
+Start with the local report to verify networking and authentication before connecting an Agent.
+
+## Publisher: share a capability
+
+The publisher owns the working Agent or automation.
+
+### 1. Start with a safe test
+
+Choose an Access Key of at least 16 characters without putting it in shell history:
+
+```bash
+read -s RELAY_ACCESS_KEY
+export RELAY_ACCESS_KEY
+```
+
+Start a harmless test capability:
+
+```bash
+relay serve \
+  --host 0.0.0.0 \
+  --port 8787 \
+  --name uppercase \
+  --description "Turn text into uppercase" \
+  -- python -c 'import sys; print(sys.stdin.read().upper())'
+```
+
+Successful startup confirms that the configured key was loaded and prints `Serving uppercase on http://0.0.0.0:8787`. If no key was configured, Relay generates and prints a temporary one. Verify the service on the publisher's computer:
+
+```bash
+curl http://127.0.0.1:8787/healthz
+```
+
+The expected response is `{"status":"ok"}`.
+
+### 2. Share connection details
+
+Find the publisher's LAN address. Common commands are `ipconfig getifaddr en0` on macOS or `hostname -I` on Linux. Send the caller exactly these values through a trusted channel:
+
+```text
+Relay URL:    http://192.168.1.42:8787
+Agent name:  uppercase
+Access Key:  <the RELAY_ACCESS_KEY value>
+Purpose:     Turn text into uppercase
+Trust scope: Trusted LAN Alpha; no sensitive or production write requests
+```
+
+`0.0.0.0` is a listen address, not the address callers should use. A firewall may also need to allow inbound TCP traffic on port 8787.
+
+### 3. Publish an existing command
+
+Relay starts the command once for each request. The command must:
+
+- read one request from standard input;
+- write the final answer to standard output;
+- write logs and diagnostics to standard error;
+- exit when that request is finished.
+
+```bash
+relay serve \
+  --host 0.0.0.0 \
+  --name ads-report \
+  --description "Read-only advertising report" \
+  -- python /path/to/ads_report.py
+```
+
+### 4. Publish a restricted Codex capability
+
+Use a dedicated workspace and the minimum credentials needed for this one capability. Do not expose your everyday Codex environment with all personal files, MCP servers, Skills, and tokens.
+
+```bash
+relay serve \
+  --host 0.0.0.0 \
+  --name code-reviewer \
+  --description "Read-only review of the dedicated workspace" \
+  -- codex exec \
+       --ephemeral \
+       --sandbox read-only \
+       --ignore-user-config \
+       --skip-git-repo-check \
+       -C /path/to/restricted-workspace \
+       -
+```
+
+Each request normally starts a fresh `codex exec`. Codex can use what is available in that restricted workspace, but Relay does not automatically resume the publisher's historical Codex sessions.
+
+## Caller: call a capability
+
+The caller only needs the `relay` CLI and the connection details. They do not need the publisher's repository or Agent implementation.
+
+Load the shared key without placing it in command history:
+
+```bash
+read -s RELAY_ACCESS_KEY
+export RELAY_ACCESS_KEY
+```
+
+### Direct execution
+
+For a person:
+
+```bash
+relay ask \
+  --target http://192.168.1.42:8787 \
+  --expect-agent uppercase \
+  "hello team"
+```
+
+For another Agent or automation, always request JSON:
+
+```bash
+relay ask \
+  --target http://192.168.1.42:8787 \
+  --expect-agent uppercase \
+  --json \
+  "hello team"
+```
+
+Successful JSON output:
+
+```json
+{
+  "capability": "uppercase",
+  "result": "HELLO TEAM"
+}
+```
+
+### Deep interaction
+
+Direct calls are stateless by default. Start a Relay-managed conversation when follow-up questions need prior context:
+
+```bash
+relay ask \
+  --target http://192.168.1.42:8787 \
+  --expect-agent ads-report \
+  --new-conversation \
+  --json \
+  "Analyze this account"
+```
+
+Save the returned `conversation_id`, then continue:
+
+```bash
+relay ask \
+  --target http://192.168.1.42:8787 \
+  --expect-agent ads-report \
+  --conversation conv_... \
+  --json \
+  "Which campaign is worst?"
+```
+
+Relay stores a bounded text transcript in memory and injects it into a fresh Agent execution. Conversations expire after one hour by default and disappear when the server restarts. The local Caller ID prevents accidental cross-caller continuation; it is not authenticated personal identity.
+
+## Give this capability to another Agent
+
+Configure `RELAY_ACCESS_KEY` in the caller Agent's environment, then give it this connection block:
+
+```text
+You can call a remote capability with the relay CLI.
+
+Target: http://192.168.1.42:8787
+Expected Agent: ads-report
+
+For a one-shot request, run:
+relay ask --target http://192.168.1.42:8787 --expect-agent ads-report --json "<request>"
+
+For follow-ups, start with --new-conversation, save conversation_id from the JSON,
+then use --conversation <conversation_id>. Treat a nonzero exit code as failure.
+Do not print or return RELAY_ACCESS_KEY.
+```
+
+The Agent needs the CLI and connection block, not the OpenAgentRelay repository.
+
+## Errors and retry behavior
+
+Operational CLI failures exit nonzero and write a JSON error to standard error:
+
+```json
+{"error":{"status":401,"code":"UNAUTHORIZED","message":"a valid access key is required"}}
+```
+
+Common codes:
+
+| Code | Meaning | Caller action |
+|---|---|---|
+| `CONNECTION_ERROR` | Wrong address, server stopped, or firewall blocked | Check the URL, LAN, server, and port |
+| `UNAUTHORIZED` | Missing or incorrect Access Key | Reload the shared key |
+| `AGENT_MISMATCH` | The public Agent name differs | Stop and confirm the publisher |
+| `BUSY` | Execution concurrency is full | Retry later with backoff |
+| `EXECUTION_TIMEOUT` | The local Agent exceeded its time limit | Ask the publisher or simplify the request |
+| `OUTPUT_TOO_LARGE` | The Agent exceeded its output limit | Ask for a smaller result |
+
+The public Agent Card is available at `/.well-known/agent-card.json`. A browser user can also open the Relay URL and enter the Access Key.
+
+## Security boundary
+
+- Bearer authentication uses one shared key; it does not identify individual teammates.
+- Transport is plain HTTP. Anyone who can observe the LAN traffic may see the key, input, and output.
+- `--expect-agent` prevents configuration mistakes; it does not cryptographically prove server identity.
+- Caller input is untrusted. A capable Agent may read files, call tools, or disclose data that its process can access.
+- Use a dedicated workspace, read-only tools, minimal credentials, and a narrowly described capability.
+- Do not expose the port to the public internet or attach production write operations.
+
+Read [SECURITY.md](SECURITY.md) before serving a real Agent.
+
+## Limits and current scope
+
+`relay serve --help` exposes execution timeout, request size, output size, concurrency, and conversation expiry controls. Version 0.1 does not include TLS, per-user permissions, automatic discovery, file transfer, progress streaming, durable conversations, multiple Agents behind one address, or a sandbox supplied by Relay.
+
+The asynchronous Hub + Runner experiment remains on the [`hub-mode` branch](https://github.com/ShakespeareLabs/open-agent-relay/tree/hub-mode). It is not part of this direct-mode Alpha path.
+
+For source development, see [CONTRIBUTING.md](CONTRIBUTING.md). Licensed under Apache-2.0.