How to launch Databricks web terminal from VS Code

Question

How to launch Databricks web terminal from VS Code

Naruto 61

Hello everyone,

I'm attempting to connect a Databricks web terminal to VS code for remote development because my existing code can only be triggered via CLI commands.

I tried utilising the Databricks VS code extensions, however it does not connect to the Databricks compute terminal. Databricks power tools extensions were also employed, and the results were the same.

Deleted

This comment has been deleted due to a violation of our Code of Conduct. The comment was manually reported or identified through automated detection before action was taken. Please refer to our Code of Conduct for more information.
Naruto 61 Reputation points

2023-05-03T06:08:07.4333333+00:00

Hi @VasimTamboli thanks for the response.

I installed the Databricks extensions for VS code, but I don't see the option "Databricks: Open Workspace" and "Databricks: Open Terminal".

I also tried configuring it using "databricks-cli" but I get the following error. I configured the cli using databricks configure --token
PRADEEPCHEEKATLA 90,641 Reputation points Moderator

2023-05-03T08:13:27.9+00:00

@VasimTamboli - I would encourage you to stop posting answers using chatgpt.

This is against the code of conduct -Artificial Intelligence (AI) usage policy for Microsoft Q&A.

Even if you are using chatgpt to answer the question on MS Q&A platform, I would encourage you to spend sometime to validate the answer before posting as an answer.

If you provide the answers without validating, this may cause alot of confusion for the Original poster.

As per the above answer there is no command called databricks workspace web-terminal and try to validate what are the options available in the databricks workspace -hcommand.
PRADEEPCHEEKATLA 90,641 Reputation points Moderator

2023-05-04T05:16:02.2133333+00:00

@Naruto - Glad to know that the below response was helpful. Thank you for marking this answer as accepted. This will help others find useful answers faster.

Please feel free to take a survey on the relevant answer. You can help us improve by leaving feedback verbatim.

Have a good day!

Regards,
PRADEEPCHEEKATLA-MSFT

Accepted answer

0 additional answers

Your answer

Deleted

This comment has been deleted due to a violation of our Code of Conduct. The comment was manually reported or identified through automated detection before action was taken. Please refer to our Code of Conduct for more information.
Naruto 61 Reputation points

2023-05-03T06:08:07.4333333+00:00

Hi @VasimTamboli thanks for the response.

I installed the Databricks extensions for VS code, but I don't see the option "Databricks: Open Workspace" and "Databricks: Open Terminal".

I also tried configuring it using "databricks-cli" but I get the following error. I configured the cli using databricks configure --token
PRADEEPCHEEKATLA 90,641 Reputation points Moderator

2023-05-03T08:13:27.9+00:00

@VasimTamboli - I would encourage you to stop posting answers using chatgpt.

This is against the code of conduct -Artificial Intelligence (AI) usage policy for Microsoft Q&A.

Even if you are using chatgpt to answer the question on MS Q&A platform, I would encourage you to spend sometime to validate the answer before posting as an answer.

If you provide the answers without validating, this may cause alot of confusion for the Original poster.

As per the above answer there is no command called databricks workspace web-terminal and try to validate what are the options available in the databricks workspace -hcommand.
PRADEEPCHEEKATLA 90,641 Reputation points Moderator

2023-05-04T05:16:02.2133333+00:00

@Naruto - Glad to know that the below response was helpful. Thank you for marking this answer as accepted. This will help others find useful answers faster.

Please feel free to take a survey on the relevant answer. You can help us improve by leaving feedback verbatim.

Have a good day!

Regards,
PRADEEPCHEEKATLA-MSFT

Answer 1

@Naruto - Thanks for the question and using MS Q&A platform.

Unfortunately, there is no way to connect web terminal using Databricks VS code extension.

Azure Databricks web terminal provides a convenient and highly interactive way for you to run shell commands and use editors, such as Vim or Emacs, on the Spark driver node. The web terminal can be used by many users on one cluster. Example uses of the web terminal include monitoring resource usage and installing Linux packages.

Steps to enable the web terminal:

Go to admin settings => Advanced => Web Terminal: Enabled (Switch toggle ON)
User's image

Steps to access the web terminal:

Go to cluster => Select cluster which is (Running) => Apps => click on Web Terminal to access.

Now we are able to access the web terminal as shown below:

User's image

For more details, refer to Azure Databricks - Web terminal.

If you want to connect to the Databricks compute terminal using Databricks VS code extension. You can follow the steps metioned here:

The Quick Start Guide provides an overview of common features.

The User Guide contains comprehesive documentation about the Databricks extension.

Summary on how to connect databricks compute terminal using Databricks VS code extension:

Open VS Code => Install databricks vs code extension => configure extension => create a python file => Attach a running cluster => "Run" icon in the tab bar and select "Upload and Run File on Databricks" => Check the debug console for the output.

User's image

Hope this helps. Do let us know if you any further queries.

If this answers your query, do click Accept Answer and Yes for was this answer helpful. And, if you have any further query do let us know.

Naruto 61 Reputation points

2023-05-03T13:37:10.66+00:00

Hi @PRADEEPCHEEKATLA thanks for the answer.

New question

I have a Plotly dash in my Databricks repo. I can start the dashboard using the web terminal but the port on which the dash app is running is not accessible from my local machine. Are there any ways to do it.
PRADEEPCHEEKATLA 90,641 Reputation points Moderator

2023-05-04T03:12:24.5933333+00:00

@Naruto - The scope of your question is different compared to the original scope of the question asked.

I would recommend creating a new thread on the same forum with as much details about your issue as possible. That would make sure that your issue has better visibility in the community.

Share via

How to launch Databricks web terminal from VS Code

0 additional answers

Your answer