Repository navigation
Document OpenRouter setup through the TypeSafe SDK - #50
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The README currently requires a TypeSafe API key, which leaves existing OpenRouter users without a documented setup path. The existing TypeSafe SDK already supports OpenRouter's System One endpoint; no additional Foreman backend is needed.
Document the matching
TYPESAFE_BASE_URLandTYPESAFE_API_KEYsettings for managed runs and attached hooks, environment precedence, the SDK's appended endpoint path, and an explicit one-request connection probe. Link the guide from the README, hook documentation, and.env.example. Runtime code and supervision policy are unchanged.Provider reference: https://openrouter.ai/docs/guides/community/typesafe-sdk
Verification
python -m pytest -q— 386 passed on Python 3.12.python -m ruff check ..git diff --checkpass.jev-latest.foreman hook --client codexwith explicit protocol events and a single configured Python-test responsibility: a Chinese documentation-only prompt does not activate the check; a Python prompt with failingunittestevidence blocks completion; passing evidence allows completion. These are bounded smoke cases, not an accuracy benchmark or a native-host activation test.No new automated tests were added for this documentation-only change. Pi integration code is untouched; its checks are left to the existing PR workflow.
Related issue
No existing OpenRouter setup issue or PR found.