Managing Your Paperspace Core Machine in iOS

The Paperspace iOS Shortcut is a handy tool for quickly managing your Core Machines on the go. No login required.

4 years ago   •   5 min read

By Jonathan Sands

‌If you're anything like me, you've become increasingly reliant on mobile devices, yet you still require a workstation with a full-fledged OS to access your suite of powerful-albeit-archaic tools needed for your line of work. Enter: Paperspace + your RDP/VNC client of choice (I use Jump Desktop). Choose from one of many core machines available from Paperspace and in minutes you have a fully-managed supercharged desktop at your fingertips, accessible on any mobile device. The question becomes: How can you manage this machine on-the-go with the least amount of friction? Sure, you can log in to the online dashboard, but you're like me, and we're lazy.

What Is an iOS Shortcut & Why?

Shortcuts is a free (and often overlooked) app for iOS devices that runs complicated tasks. Combined with the Paperspace API, Shortcuts becomes a powerful tool that allows you to manage your machines with only a few taps.

Shortcuts should come pre-installed on your iOS device, but if you deleted it you can re-download it here.

I began the development of a Paperspace iOS Shortcut primarily to serve one purpose: the ability to quickly start/stop/restart the VM. If your machine is billed at an hourly rate, chances are that you keep the machine off when you are not using it. That means each time you want to actually use the machine, you must first turn it on. If you are using the native Paperspace client, this happens automatically. However, currently there is no native iOS or Android Paperspace client. Instead, you can simply access the machine via RDP/VNC (click here or here if you want to learn more about setting this up).

To sum it all up:

Problem # 1: RDP/VNC only works if your Paperspace Machine is ON
+
Problem #2: If you choose billing on an hourly basis, you likely keep your machine in an OFF state
+
Problem #3: There is no native iOS/Android Paperspace application to easily manage your machine(s) on-the-go
=
_________________
Solution: A Shortcut that interfaces with Paperspace's API to manage your machine with a few clicks, and no login required.

Paperspace iOS Shortcut

The Paperspace iOS Shortcut will evolve over time based on your feedback.
To report bugs, request a new feature, or other general inquiries, feel free to contact me.

Download Version 1.0 Here:
https://www.icloud.com/shortcuts/712c756367644e3f81636512a6fce44a

Note that unlike apps, Shortcuts do not update automatically via the app store, so please be sure to check back here to download the latest version.

Version 1.0 (04.20.20)

Manage multiple machines, and for each:

  • View Current Machine State (off, starting, ready, etc.)
  • Start / Stop / Restart Machine
  • View Machine Specs
    • Name
    • ID
    • Region
    • Public IP (if applicable)
    • RAM
    • CPU
    • GPU
    • Available Storage (% and GB)
  • View Current Month Billing
    • Monthly Total
    • Billing Period
    • Usage Type
    • Hourly Rate
    • Hours Used
    • Storage Rate
    • Public IP (if applicable)
  • Update Machine Name
  • Copy Public IP to Clipboard (if applicable)

Installation

Follow these steps to get started:

  1. Navigate to Settings -> Shortcuts, and turn on "Allow Untrusted Shortcuts"

Note: Only Apple shortcuts are considered "trusted", this setting is required for all third-party shortcuts. If you do not have the Shortcuts app on your iOS device, download it here.

If this is your first time using Shortcuts, you will not be able to change this setting until you have run at least one shortcut. Open up the Shortcuts app and try it out. You will then be able to go back to Step #1.

  1. Create a new Paperspace API key via the Paperspace Web Console.
    Copy your created API key, as it will need to be added during set-up.

  2. Obtain your Machine ID(s), also referred to as hostname(s). This can also be found via the Paperspace Web Console. Copy the hostname(s) for later reference.

  3. Download the Latest Version of Paperspace iOS Shortcut.
    You are required to scroll through all of the actions of the shortcut.
    At the bottom, select "Add Untrusted Shortcut".

  4. Follow the instructions in adding your API Key & Machine IDs.
    Ensure there are no blank lines in your Machine IDs.

Set-up is complete!

Optional Steps:

  • Add your shortcut to the Widgets page for quick access.

    1. From the homescreen, swipe to the right to reveal your Widgets.
    2. Scroll to the bottom and select "Edit".
    3. Add "Shortcuts" to your Widgets list.
    4. You can select which shortcuts are displayed via "Customize in Shortcuts" on the Widgets screen.
  • Add an icon to your homescreen.

    1. Download your desired Paperspace icon image to your iOS Photos library. Click here for an example, pulled from Paperspace's Github.
    2. Open up the Shortcuts app on your iOS device.
    3. Select the three dots "..." for the Paperspace shortcut.
    4. Again, select the three dots "...".
    5. Tap on "Add to Home Screen".
    6. Tap the small icon & select "Choose Photo". Select your downloaded photo. You can rename the app if you like.
    7. Click "Add" in the top-right corner to complete this process.
    8. You will now see the app icon on your homescreen.

Limitations

Conclusion

The Paperspace iOS Shortcut is a handy tool for quickly managing your Paperspace Core Machines while on-the-go.

Download Version 1.0 Here:
https://www.icloud.com/shortcuts/712c756367644e3f81636512a6fce44a

The Paperspace iOS Shortcut will evolve over time based on your feedback.
To report bugs, request a new feature, or other general inquiries, feel free to contact me.

Note: unlike apps, Shortcuts do not update automatically via the app store. Please be sure to check back here to download the latest version.

Spread the word

Keep reading