docs(AGENTS): correct persisted key filename to api-key.txt#1409
Open
rajshah4 wants to merge 1 commit into
Open
docs(AGENTS): correct persisted key filename to api-key.txt#1409rajshah4 wants to merge 1 commit into
rajshah4 wants to merge 1 commit into
Conversation
The dev launcher (scripts/dev-safe.mjs: DEFAULT_API_KEY_PATH) and the Docker entrypoint (docker/entrypoint.sh: API_KEY_FILE) both persist the session/backend API key to ~/.openhands/agent-canvas/api-key.txt. AGENTS.md still referenced the old ~/.openhands/agent-canvas/session-api-key.txt in three places (local mode, the security key list, and the Docker section). DEFAULT_SESSION_API_KEY_PATH remains only as a deprecated alias of DEFAULT_API_KEY_PATH; no runtime code writes session-api-key.txt. Docs-only; flag/env names (--session-api-key, VITE_SESSION_API_KEY, SESSION_API_KEY) are unchanged.
|
@rajshah4 is attempting to deploy a commit to the openhands Team on Vercel. A member of the Team first needs to authorize it. |
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
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.
HUMAN:
Docs-only change. I reviewed the rendered diff and confirmed the three corrected paths match the key file the launcher and Docker entrypoint actually write.
AGENT:
Why
AGENTS.mddocuments the persisted session/backend API key file as~/.openhands/agent-canvas/session-api-key.txtin three places, but the current code persists it to~/.openhands/agent-canvas/api-key.txt. The filename was renamed in code but not in this doc, so anyone readingAGENTS.mdto debug auth gets the wrong path.Summary
session-api-key.txttoapi-key.txtinAGENTS.md(local-mode auth, the security key list, and the Docker all-in-one section).--session-api-key,VITE_SESSION_API_KEY,SESSION_API_KEYare not filenames. The automation key (automation-api-key.txt) is untouched.Issue Number
N/A
How to Test
Documentation-only; no runtime behavior changes. To confirm the corrected path is the real one:
DEFAULT_SESSION_API_KEY_PATHremains only as a@deprecatedalias ofDEFAULT_API_KEY_PATH; no runtime code writessession-api-key.txt.Video/Screenshots
N/A — documentation-only.
Type
Notes
Scoped to
AGENTS.md(3 lines). Found while reconciling a downstream tutorial against Agent Canvas v1.0.0.