Skip to Content

PairSpaces

DocsBlog

PairSpaces

Quickstart

Get Up and Running with PairSpaces

What We'll Do

This is a rapid onboarding guide to PairSpaces. You will create a Space, access the Space, and work with someone from your Space.

You will use the Free Tier and not be charged for any services used. The Free Tier limits the number of Spaces you can create to three, the time they are available to one day, and their configuration (CPU plus RAM).

Setting Up

Signing Up

Visit https://pairspaces.com/auth/signup and choose a way to create a PairSpaces account.

or

We'll send a verification code to your email address.

If you choose to Sign Up with Email a one-time password (OTP) will be sent to your email address. Enter the OTP when prompted.

Confirm your email

We sent a code to your email address

Choose a Provider

Right now you can choose Amazon Web Services as the platform for your Spaces.

Configure your PairSpaces Cloud

Let's choose a cloud provider. Right now we support AWS only.

And then select a region for your Spaces.

Configure your PairSpaces Cloud

Last step... Select a region for your Spaces.

Teams

Creating a team is not required to complete the Quickstart, but it will make it easier to understand the ways of working together that PairSpaces enables.

Create a Team

To work with someone, you'll need to add a team member. Select the Team menu item under Accounts.

No Team.

Add team members to collaborate in your Spaces.

Click Add Members and enter the email address of someone you want to work with. For Role, select Member.

Add to Your Team

Include an email address and select a role for the new team member.

PairSpaces will email your team member a link to complete their account setup.

Spaces

Create a Space

When you first access PairSpaces, you will have no Spaces.

No Spaces.

Create a Space to work with your team.

To create a Space, click Create Space and choose Join your Space from Terminal or IDE from the Space Types tab.

Build Your Space

From the Space Configuration tab, enter a name for your Space and choose a CPU/Memory combination.

Build Your Space

Share a Space

Once your team member completes their account setup, you can share your Space with them. Click the Share icon (

) for the Space you just created.

You have one Space.

Your Spaces

NameStatus
Space OneRunning

Select the team member that you just added and click Share.

Share Your Space

Sharing allows your team to log into your Space and collaborate in real time from anywhere.

Your team

Choose a team member to work with.

Work Together

Let's get you and your team working together in your Space. First, download the PairSpaces CLI. Choose the version of the PairSpaces CLI for your operating system below.

Linux AMD64 Linux ARM64 macOS Silicon macOS Intel Windows AMD64 Windows ARM64

From your Terminal app, you can list your Spaces using pair spaces, but first you will sign in from the PairSpaces CLI.


> pair spaces

You are signed out. Signing you in...

1. Go to the browser that just opened. If a browser window did not appear, navigate to https://pairspaces.com/device/verify.
2. Enter the user code M6R6I9IZ.
3. When your session is created, return to this prompt.

And then you will see the Spaces you created.


> pair spaces

Space ID			        Name				        Shared with you	
-------------------------	-------------------------	----------------
677029e3e72826e42fe49fcb	Space One			        No		
67702b34e72826e42fe4a059	Space Two			        No		
-------------------------	-------------------------	----------------

Before you can access your Space you need a public/private keypair. Create your keypair using pair keys.


> pair keys

Your private key is available from ~/.ssh/id_ecdsa and your previous key was moved to ~/.ssh/id_ecdsa.bak.

And now access your space using pair space SPACE_ID, where SPACE_ID is the unique identifier for your Space (it's the value for Space ID in the output from pair spaces).


> pair space 677029e3e72826e42fe49fcb

   ,     #_
   ~\_  ####_        Amazon Linux 2023
  ~~  \_#####\
  ~~     \###|
  ~~       \#/ ___   https://aws.amazon.com/linux/amazon-linux-2023
   ~~       V~' '->
    ~~~         /
      ~~._.   _/
         _/ _/
       _/m/'
Last login: Wed Jan 01 09:41:01 2025 from YOUR_IP_ADDRESS
[ec2-user@ip-SPACE_IP_ADDRESS ~]$

Using an IDE

Now that you can access your Space, let's set up your IDE. We're going to use VSCode here, but the steps are similar for other IDEs.

Open VSCode's command panel and click on the command Remote-SSH: Connect to host....

A list of configured SSH profiles will appear. Select the SSH profile identified by your Space ID.

You will see an empty VSCode workspace. Click on Open Folder and navigate to /space. VSCode will prompt you to trust the workspace's folders.

Check the checkbox to trust all files in the parent folder and click Yes, I trust the authors.

Clone a Repository

PairSpaces configures your SSH session to forward keys to your Space. This makes it possible to use any SSH keys on your local machine in your Space. Your keys are never copied to your Space. To enable key forwarding, use ssh-add /path/to/my/key from your local machine.

And then from your Space, you can use git clone ... to clone your repository in your Space.

Next

CLI