PyCharm 2025.2 Help

使用内置 SSH 终端和远程 SSH 外部工具

本教程的内容

本教程描述了如何使用 PyCharm 的内置 SSH 终端和远程工具。

SSH 基础知识不在本教程的范围内。

先决条件

在开始之前,请确保:

  • 您使用的是 PyCharm 3.0 或更高版本。 本教程是基于 PyCharm 2016.2 创建的。

  • 您可以访问一个 SSH 服务器。

使用 SSH 客户端

让我们看看如何使用 PyCharm 的内置 SSH 客户端。

开始连接

从主菜单中选择 工具 | 启动 SSH 会话... ,然后点击 编辑凭据

py_ssh_start_session.png

提供连接信息

SSH 会话 对话框中,指定连接信息:主机(本地或远程)、端口、登录名和密码:

ssh_connection_information.png

瞧瞧!

点击 确定 后,SSH 会话将在终端工具窗口的专用选项卡中启动:

ssh_connection.png

在 SSH 会话中我们可以做什么?

与交互式会话一样……远程运行命令、复制粘贴、使用上下箭头键浏览命令历史记录。

使用远程 SSH 外部工具

让我们定义一个外部工具,通过 SSH 运行命令,例如显示日历。

配置 SSH 外部工具

打开设置对话框(主工具栏上的 ),在 工具 节点下,选择页面 远程 SSH 外部工具。 点击 创建一个新的远程工具,并在 创建工具 对话框中指定新工具的设置:

  • 名称 字段有助于指定新工具的可见名称。 接下来的两个字段是可选的:

    • 描述 字段中输入一些有意义的描述。

    • 字段表示一个组,其指定的名称将在 工具 菜单中创建,新 SSH 外部工具将被放置在该组下。

  • 显示于 区域中,指定您希望在哪里看到新工具。 在这种情况下,仅选择复选框 主菜单

  • 连接设置 区域中,点击单选按钮 部署服务器 并选择 每次运行时选择服务器。 这意味着每次您想运行此外部工具时,都需要指定连接设置。

  • 最后,在 工具设置 区域中,指定要远程执行的工具。 在下面的截图中,我们正在运行一个 bash 命令;参数和工作目录是可选的。 我们还可以利用宏来注入当前命令名称。

ssh_external_tools.png

点击 确定 关闭 创建工具 对话框并返回页面 远程 SSH 外部工具。 我们可以在列表中看到新工具:

ssh_external_tools_list.png

启动 SSH 外部工具

一旦工具设置完成,它将显示在之前选择的菜单中。 在这种情况下,这是 工具 菜单,它将在组下显示新创建的远程 SSH 外部工具,该组在上一节中定义:

py_ssh_tools_menu.png

让我们选择此命令,看看会发生什么。 首先,建议您选择要连接的服务器。 选择 编辑凭据 后,指定连接设置。

最后,您会看到日历! 就在这里:

ssh_external_rool_result.png
最后修改日期: 2025年 9月 26日