Skip to content

Latest commit

 

History

History
74 lines (59 loc) · 3.34 KB

quickstart.mdx

File metadata and controls

74 lines (59 loc) · 3.34 KB
title Quickstart
description Add your first host, connect, run a command and open SFTP in a few minutes.
icon rocket

This walkthrough uses a demo host. Replace demo, 127.0.0.1 and port 2222 with your own server. You need YourSSH installed and an SSH server you can sign in to.

On the **Hosts** dashboard, click **New host**. The host editor opens on the right. Keep **SSH** selected at the top.
<Frame caption="The host editor, empty.">
![The New Host panel with SSH, RDP and VNC tabs, general and credentials fields](/images/02-add-host/01-new-host-panel.png)
</Frame>
Enter a **Label** (a name you will recognize), the **Hostname or IP**, the port (default `22`), your **Username** and **Password**. To use a key or your SSH agent instead, change **Auth method**. See [Hosts](/user-guide/hosts) for every option.
<Frame caption="A filled-in host.">
![The host editor filled with the label Demo Server, host 127.0.0.1, port 2222 and user demo](/images/02-add-host/09-filled-form.png)
</Frame>
Click **Test** to check the address and credentials without opening a shell. A result such as **Connected** with a latency appears next to the button. Click **Save**. The host appears on the dashboard.
<Frame caption="The saved host on the dashboard.">
![The hosts dashboard with the new Demo Server card inside the DEMO group](/images/02-add-host/11-dashboard-with-host.png)
</Frame>
Double-click the host card to open a terminal tab (or open its three-dot menu and choose **Connect**). The first time you connect, YourSSH pins the server's host key. See [Host keys](/user-guide/host-keys) for what that means and when you get a warning.
<Frame caption="Hover a card for quick actions: test, SFTP and the full menu.">
![A host card with the test, SFTP and more-actions buttons visible on hover](/images/03-first-connect/02-card-hover-actions.png)
</Frame>
When the shell prompt appears, type a command and press Enter.
<Frame caption="A connected terminal after running ls -la.">
![A terminal tab connected to Demo Server, showing the output of ls -la](/images/03-first-connect/07-terminal-ls.png)
</Frame>
Click the folder icon on the host card, or open the card's menu and choose **SFTP**. The dual-panel file manager shows your computer on the left and the server on the right.
<Frame caption="Dual-panel SFTP.">
![The SFTP screen with the local home folder on the left and the remote home folder on the right](/images/07-sftp/03-dual-panel.png)
</Frame>

Next steps

Groups, tags, keys, jump hosts and per-host options. Tabs, split view, search and hotkeys. Transfer files in both directions. Generate an SSH key and deploy it to a host.