Skip to content

Document iterm2:///reveal URL scheme #120

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sherifnada wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Document iterm2:///reveal URL scheme #120

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions source/_includes/3.6/documentation-command-selection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,9 @@ The optional `d` query parameter gives a directory to change into prior to runni

Normally when you open a command URL you are presented with a window that describes what will be done and offers options on how to run it (e.g., in a new tab, a new window, or in the current session). The optional `silent` query parameter suppresses this window. A confirmation dialog is shown instead. If the user consents, the command runs in the background and its output is not shown. This query parameter does not take a value.

### Reveal URLs

iTerm2 also handles URLs of the form `iterm2:///reveal?sessionid=<id>`, which bring a specific session to the front. The `sessionid` parameter takes the value of that session's `ITERM_SESSION_ID` environment variable (for example, `w0t0p0:ABCD-EFGH-...`).

This is useful for jumping back to a session from an external script, note, or other application&mdash;for instance, recording the session ID when starting a long-running job and opening the URL later to return to it.

6 changes: 6 additions & 0 deletions source/_includes/documentation-command-selection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,9 @@ The optional `d` query parameter gives a directory to change into prior to runni

Normally when you open a command URL you are presented with a window that describes what will be done and offers options on how to run it (e.g., in a new tab, a new window, or in the current session). The optional `silent` query parameter suppresses this window. A confirmation dialog is shown instead. If the user consents, the command runs in the background and its output is not shown. This query parameter does not take a value.

### Reveal URLs

iTerm2 also handles URLs of the form `iterm2:///reveal?sessionid=<id>`, which bring a specific session to the front. The `sessionid` parameter takes the value of that session's `ITERM_SESSION_ID` environment variable (for example, `w0t0p0:ABCD-EFGH-...`).

This is useful for jumping back to a session from an external script, note, or other application&mdash;for instance, recording the session ID when starting a long-running job and opening the URL later to return to it.