This page lists directives related to Cloud Shell Editor.
Open file
<walkthrough-editor-open-file filePath=" FILE_PATH
"> LINK_TEXT
</walkthrough-editor-open-file>
Creates a link that opens a file on the Cloud Shell disk in the editor.
Parameters
Parameter | Type | Description |
---|---|---|
filePath
|
String | A file path relative to the workspace open in Cloud Shell. |
Open file with text selected
< walkthrough
-
editor
-
select
-
line
filePath
=
" FILE_PATH
"
startLine
=
" START_LINE
"
endLine
=
" END_LINE
"
> LINK_TEXT
< /
walkthrough
-
editor
-
select
-
line
>
Creates a link that opens a file on the Cloud Shell disk in the editor, and selects lines of text within it.
Parameters
Parameter | Type | Description |
---|---|---|
filePath
|
String | A file path relative to the workspace open in Cloud Shell. |
startLine
|
Integer | The file line where the selection starts.
Unlike the code editor, the line count
starts from 0
. |
endLine
|
Integer | The file line where the selection ends. The
selection ends at the beginning of this
line. Unlike the code editor, the line
count starts from 0
. |
startCharacterOffset
|
Integer | The character number in the startLine
to start the selection from. |
endCharacterOffset
|
Integer | The number of characters after the endLine
position to select. |
Open file with text selected by regular expression
< walkthrough
-
editor
-
select
-
regex
filePath
=
" FILE_PATH
"
regex
=
" REGEX
"
> LINK_TEXT
< /
walkthrough
-
editor
-
select
-
regex
>
Creates a link that opens a file on the Cloud Shell disk in the Cloud Shell Editor and selects text in the file based on a regular expression. Only the first match in the file is selected.
Parameters
Parameter | Type | Description |
---|---|---|
filePath
|
String | A file path relative to the workspace open in Cloud Shell. |
regex
|
String | A regular expression to match. Multi-line is on. |
Spotlight pointers
<walkthrough-editor-spotlight spotlightId=" SPOTLIGHT_ID
"> LINK_TEXT
</walkthrough-editor-spotlight>
<walkthrough-editor-spotlight cssSelector=" CSS_SELECTOR
"> LINK_TEXT
</walkthrough-editor-spotlight>
Creates a link that highlights the specified UI element in the editor.
You can spotlight an element on the page in one of two ways:
- Spotlight ID
- Using the
spotlightId
parameter, specify a DOM element'sspotlight-id
property value to select the element. - CSS selector
- For elements without a spotlight
ID, use the
cssSelector
parameter with a CSS selector to select the element.
Only one of these parameters is required. If both are provided, spotlightId
is used.
Parameters
Parameter | Type | Description |
---|---|---|
spotlightId
|
String | An element's spotlight ID. |
spotlightItem
|
String | Required when spotlightId
is set to navigator
.
The expected value is a file path relative to the
workspace open in Cloud Shell. |
The spotlightId
parameter only accepts the following values:
activity-bar-cloud-apis
activity-bar-cloud-k8s
activity-bar-cloud-run
activity-bar-debug
activity-bar-scm
activity-bar-search
cloud-code-gke-explorer
cloud-code-k8s-explorer
cloud-code-k8s-explorer-minikube
cloud-code-logs-viewer-cluster
cloud-code-logs-viewer-container
cloud-code-logs-viewer-deployment
cloud-code-logs-viewer-namespace
cloud-code-logs-viewer-pod
cloud-code-logs-viewer-refresh
cloud-code-logs-viewer-stream-toggle
cloud-code-new-app
cloud-code-debug-on-k8s
cloud-code-run-on-k8s
cloud-code-open-welcome-page
cloud-code-cloud-run-deploy
cloud-code-run-on-cloud-run-emulator
menu-edit
menu-file
menu-terminal
menu-terminal-new-terminal
cloud-code-status-bar
minikube-status-bar
debug-configuration
file-explorer
navigator
output