Skip to content

CloudWorkstation GUI Guide

CloudWorkstation Logo

Welcome to the CloudWorkstation GUI!

The CloudWorkstation GUI makes managing your research cloud computers easy - no more typing commands! Just click buttons and see everything visually.

What is the GUI?

GUI stands for "Graphical User Interface." Instead of typing commands, you'll use: - Mouse clicks - Buttons - Menus - Windows

The GUI is perfect for visual learners and anyone who prefers using a mouse over typing commands.

Main Features of the GUI

Main Dashboard

The Dashboard shows you: - All your running and stopped cloud computers - Real-time cost information per instance - Quick launch buttons for common templates - System status and notifications - Profile and AWS region information

Key Features: - Instance Overview: See all your instances at a glance with status indicators - Cost Monitoring: Real-time cost tracking with daily estimates - Quick Actions: Launch, stop, hibernate, and connect with one click

Browse research environments with pictures and descriptions: - Visual cards for each template - Detailed descriptions of included software - One-click launching - Size selection sliders (XS to XL)

Instance Manager

Manage all your cloud computers in one place: - Start and stop with a single click - Connect buttons that open connections automatically - Color-coded status indicators - Detailed cost and usage information

Storage Manager

Manage your data storage visually: - Create new storage volumes with size sliders - Drag-and-drop to attach storage to computers - Visual space usage indicators - One-click backup options

Cool GUI Features

System Tray / Menu Bar

The GUI runs in your system tray or menu bar (top of your screen), so you can: - See status at a glance - Get notifications about your cloud computers - Access CloudWorkstation without opening a terminal - Monitor costs continuously

Profile Management

Manage different AWS accounts from one place: - Switch between your personal AWS account and invited accounts - See which profile you're currently using in the sidebar - Add new personal profiles for your own AWS accounts - Add invitation profiles when someone invites you to use their account - Learn more in the Multi-Profile Guide

Automatic Updates

The GUI checks for updates and lets you know when: - New CloudWorkstation versions are available - New templates have been added - Your cloud computers need attention

Dark and Light Themes

Choose the colors that work best for you: - Dark theme for nighttime use - Light theme for daytime use - Automatic switching based on your computer's settings

How to Use the GUI

  1. Starting the GUI 

    cws gui
    Or click the CloudWorkstation icon in your applications menu.

  2. Launching a Cloud Computer

  3. Click "Launch New Instance"
  4. Select a template from the gallery
  5. Enter a name for your computer
  6. Choose a size (XS to XL)

  7. Click "Launch"

  8. Connecting to Your Computer

  9. Find your computer in the Instances list
  10. Click "Connect"
  11. Choose SSH (command line) or Web (browser)

  12. Start working!

  13. Managing Your Computer

  14. Click "Stop" when you're done for the day
  15. Click "Start" when you want to use it again
  16. Click "Delete" when you're completely finished

Switching Between AWS Profiles

The CloudWorkstation GUI makes it easy to switch between different AWS accounts:

  1. See your current profile
  2. Look in the sidebar under "AWS Profile"

  3. It shows the name and type (Personal or Invitation)

  4. Switch profiles

  5. Click the "Switch Profile" button in the sidebar, or
  6. Go to Settings → Profile Management

  7. Select the profile you want to use

  8. Add a new personal profile

  9. Go to Settings → Profile Management
  10. Click "Add Personal Profile"
  11. Fill in the profile information

  12. Click "Submit"

  13. Add an invitation profile

  14. Go to Settings → Profile Management
  15. Click "Add Invitation"
  16. Enter the invitation token and other details
  17. Click "Submit"

When you switch profiles, the GUI automatically refreshes to show the cloud computers in that AWS account.

Get Help

If you need help with the GUI:

  1. Check the documentation at docs.cloudworkstation.org

  2. Run the tests to check your setup: 

    cws test

  3. Visit the community forum at community.cloudworkstation.org

  4. Report issues on GitHub at github.com/scttfrdmn/cloudworkstation/issues