Open Connections with Core Shell URL Schemes

Core Shell supports URL schemes that let you open an existing Profile or connect to an SSH server directly from other apps, scripts, or the command line.

1. Open an Existing Profile

Use the following URL scheme to open a terminal using an existing Profile:

coreshell://profile?name=Fancy Profile Name&newtab=yes

Parameters:

Parameter Description
name The name of the existing Profile to open.
newtab Whether to open the terminal in a new window tab. Defaults to yes. Supported values are yes and no.

2. Connect to an SSH Server

Use the following URL scheme to connect directly to an SSH server:

coreshell://127.0.0.1?name=My SSH Server&newtab=yes&privateKeyName=id_ed25519&certificateName=id_ed25519.cert

Replace 127.0.0.1 with the hostname or IP address of the SSH server you want to connect to.

URL Parameters

Parameter Description
name The default title of the terminal window.
newtab Whether to open the terminal in a new window tab. Defaults to yes. Supported values are yes and no.
retryAttempts The number of connection retry attempts. Defaults to 999.
privateKeyName The name of a private key imported into Core Shell. You can also specify a private key file path using the IdentityFile directive in ssh_config(5).
certificateName The name of a certificate imported into Core Shell. You can also specify a certificate file path using the CertificateFile directive in ssh_config(5).
colorScheme The terminal color scheme. Supported values: Basic, Dracula, Grass, Homebrew, Man Page, Novel, Ocean, Red Sands, and Solarized.

Parameter names are case-sensitive. Use the exact spelling shown above.

Additional SSH connection options can be configured using directives from ssh_config(5).

The Host and Match directives are not supported.

Due to sandbox restrictions, the following directives are unavailable in the Mac App Store version. The Codinn Store and Setapp versions are not affected.

  • AddKeysToAgent
  • ProxyCommand
  • ProxyUseFdpass
  • UserKnownHostsFile
  • CertificateFile
  • IdentityAgent
  • IdentityFile
  • ControlMaster
  • ControlPath
  • ControlPersist
  • LocalCommand
  • PermitLocalCommand
  • SecurityKeyProvider
  • ForwardX11
  • ForwardX11Timeout
  • ForwardX11Trusted
  • XAuthLocation
  • EnableSSHKeysign
  • KnownHostsCommand

3. Test the URL Scheme

You can test the URL scheme from Terminal using the open command:

open "coreshell://127.0.0.1?name=My SSH Server&newtab=yes&privateKeyName=id_ed25519&certificateName=id_ed25519.cert"

This example opens an SSH connection to 127.0.0.1 using the specified private key and certificate. Make sure the server is reachable and the key and certificate are available to Core Shell.

You can use the same approach to launch connections from shell scripts, automation tools, or other applications that support URL schemes.

This topic was automatically closed after 2 minutes. New replies are no longer allowed.