docs: document opening a file at a line via the payload query parameter - #7909
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.
Relates to #1964.
What
Adds an FAQ entry documenting how to open a specific file — optionally at a line and column — directly from a URL, using the
payloadquery parameter (openFile+gotoLineMode) alongside the existingfolderparameter.Why
#1964 ("Ability to open a file directly using a URL") has been open since 2020 and is in the backlog, but the capability already exists: code-server inherits upstream VS Code web's
payloadquery parameter, so no new patch is needed — it just isn't documented anywhere. The FAQ currently only mentionsworkspaceandfolder.Verified working on code-server 4.122.1 behind a reverse proxy:
opens
/tmp/test.txtwith the cursor at line 6, column 3.The new entry includes a small shell snippet for generating such links from a CLI (e.g. an
code <file> --line Nstyle wrapper that emits a browser link), which is the use case that keeps coming up in #1964.