Help Center/ CodeArts Agent/ User Guide (IDE)/ Remote Development/ SSH Development
Updated on 2026-07-29 GMT+08:00
View PDF
Share

SSH Development

The Remote SSH function of CodeArts Agent IDE allows users to directly access and manage files on remote hosts from their local PC, enabling highly efficient remote development and maintenance without downloading files locally. With this function, you can utilize the complete development toolchain directly within the IDE—including code generation, debugging, and AI assistance—greatly improving the convenience and efficiency of remote work.

Figure 1 Remote SSH connection

Constraints

Table 1 Constraints

Category

Description

Remote environment

The openssh-server has been installed in the remote target environment.

Configuration

The AllowTcpForwarding parameter in the /etc/ssh/sshd_config file is set to yes.

OS version
  • glibc: 2.18 or later 
    # Check the glibc version.
ldd --version
  • glibcxx: 3.4.22 or later 
    # Check the glibcxx version.
  # Ubuntu
  strings /usr/lib/x86_64-linux-gnu/libstdc++.so.6 | grep GLIBCXX
  # openEuler
  strings /lib64/libstdc++.so.6 | grep GLIBCXX

Login script

The system login script (typically ~/.bashrc) should include detection logic for non-interactive logins to ensure that the script is executed only within interactive terminals.

# Add the following at the beginning of the ~/.bashrc login script:
# If not running interactively, don't do anything
case $- in
    *i*) ;;
      *) return;;
esac

Webpage preview

Direct opening of the browser for preview via the file:/// protocol is currently not supported.

Connecting to a Remote Host

  1. Log in to CodeArts Agent IDE as instructed in Quick Start.
  2. Click in the left menu bar of the IDE to open the remote development page.
  3. Under SSH hosts, click to open the window for creating an SSH connection.

    You can also click Connect Current Window to Host or Connect New Window to Host to quickly establish an SSH connection.

    • Click Connect Current Window to Host to establish an SSH connection in the current IDE window.
    • Click Connect New Window to Host to open a new IDE window and establish an SSH connection in it.
    Figure 2 Clicking the icon for adding an SSH host

  4. Set the remote host information and click Save.

    Figure 3 Creating an SSH connection
    Table 2 Parameters for creating an SSH connection

    Type

    Parameter

    Description

    General

    Name

    Set an alias for the SSH connection for easy identification.

    Host Address

    Enter the IP address of the target host to be connected.

    Port

    Enter the TCP port number listened by the SSH service. The default value is 22.

    Proxy

    Determine whether to connect to the target host by setting a proxy server.

    • No proxy: Connect directly and skip all proxy settings.
    • Application proxy: Select this option if you want to access the target host through a proxy server (for example, on a company intranet or restricted network). You can click to access the detailed proxy settings page.
      • Host address: IP address of the proxy server.
      • Port: TCP port number listened by the proxy server.
      • Proxy authentication: If the proxy server requires identity authentication, you need to enter the username and password.
      • Check connection: Check whether the access to the target URL is normal with the current proxy configuration.

    Username

    Enter the username for logging in to the target host.

    Authorization

    Three authentication modes are provided: Password, Key-based, and Keyboard Interactive (two-factor authentication). You can choose any one of them.

    Password

    Enter the password for logging in to the target host.

    This parameter is displayed only when Authentication is set to Password or Keyboard Interactive.

    Private key

    Click and select the local SSH private key file (in the .pem, .ppk, or .key format).

    This parameter is displayed only when Authentication is set to Key-Based.

    Passphrase

    If the private key file is encrypted, enter the decryption password.

    This parameter is displayed only when Authentication is set to Key-Based.

    Advanced

    Keep Alive

    If this option is selected, the client periodically sends heartbeat packets to the server to check whether the connection is still valid.

    Interval: interval for sending keepalive messages, in seconds. Its default value is 30.

    Jump Hosts

    Determine whether to access the target host by configuring an intermediate server. This function is usually used for secure intranet access.

    After this function is enabled, the SSH connection is first established to the specified jump host, which then connects to the target host.

  5. In the displayed dialog box, click New Window or Current Window to open the SSH connection in a new window or in the current window.

    Wait until the connection is complete. If no error message is displayed and the connection information is displayed in the status bar in the lower left corner, the connection is successful.

  6. After the connection is successful, click Open Folder in the explorer, browse and select the target folder on the remote device, and click OK to open it.

Managing Remote Connections

Table 3 Managing remote connections

Operation

Instruction

Editing a remote connection

In the remote development of CodeArts Agent IDE, hover the cursor over the target remote connection and click to modify configurations.

Disabling a remote connection

In the remote development of CodeArts Agent IDE, hover the cursor over the target remote connection and click to disable the connection. After the connection is disabled, you can click to reconnect.

Deleting a remote connection

In the remote development of CodeArts Agent IDE, hover the cursor over the target remote connection and click to delete the connection from the list.

Other Operations

Table 4 Other operations

Operation

Description

Expands all hierarchical levels under SSH hosts and unfolds all subnodes, allowing users to quickly browse and manage a large number of connection items.

Collapses all expanded SSH host nodes to reduce the number of GUI layers and help users obtain a more neat view.

Displaying or hiding detected CodeArts projects/workspaces

Controls whether to display remote projects/workspaces and connection information automatically detected by the IDE and related to CodeArts.

Importing host settings

Supports importing SSH host configuration files (typically in .export format) from the local machine. This facilitates configuration migration between different computers or users, avoiding manual, repetitive entry of connection information to improve efficiency and consistency.

Exporting host settings

Exports current SSH host connection configurations to a .export file. This is used to back up your SSH configurations or quickly unify remote development environments within a team, achieving efficient and consistent remote connection setups.

Synchronizing information with local extensions

Triggers a synchronization of the current SSH host configuration to a local extension. This is typically used to ensure that extensions can properly recognize and use the latest SSH connection details, preventing connection issues caused by inconsistent configurations and improving stability and consistency.

Opening proxy manager

Opens the proxy server settings. If your network environment requires a proxy server to access remote hosts (such as an enterprise intranet), you can configure an HTTP proxy on this page to forward SSH connections through the proxy, ensuring successful connections to target hosts.

Opening jump host manager

Opens jump host configurations. When you cannot connect directly to the target server and require an intermediate server (a jump host), you can configure the relevant settings on this page to securely access the target server.

Showing connection logs

Views detailed SSH connection logs. When a connection fails or behaves abnormally, you can use these logs to troubleshoot issues and locate root causes.

Setting log levels

Adjusts the verbosity level of SSH connection logs, such as Trace, Debug, and Info (default: Info).

Opening help documentation

Opens the official help documentation to access detailed guides on SSH host configuration and basic operations.
Parent Topic: Remote Development