surf-controller 0.3.8

CLI interface to control SURF VMs

🏄‍♂️ Surf Controller

built with

🌊 Overview

Surf Controller is a powerful CLI tool for managing your cloud workspaces with ease! It provides a user-friendly interface to monitor, pause, and resume your virtual machines (VMs) effortlessly.

🚀 Features

• 📊 Interactive CLI interface
• 🔄 Real-time VM status updates
• ⏸️ Pause and ▶️ resume VMs with a single keystroke
• 📋 Multi-select functionality for batch operations
• 📜 Live log viewing

🛠️ Installation

Use rye Rye to install surf-controller globally or add it to your local environment. Of course, you can also use pip to install it.

rye tools install surf-controller

rye add surf-controller

pip install surf-controller

This installs the surfcontroller command.

🔑 First-time Setup

You can find the documentation for the API hier: API Documentation

On your profile you can create your own API token.

You can obtain the CSRF tokens by authorizing directly with the Surf API. Use the green lock icon in the top right corner to authorize with your API-token and obtain the CSRF token by executing a request.

Copy both tokens and use them during configuration.

Run the configuration by starting the controller:

surfcontroller

On first run, Surf Controller will:

1. 📁 Create a configuration directory in your home folder
2. 📄 Copy a default configuration file
3. 🔒 Prompt you for API and CSRF tokens

🎮 Usage

Run the controller:

surfcontroller

🕹️ Controls

navigate / select

• j: Move cursor down
• k: Move cursor up
• Enter: Select/deselect VM
• a: toggle Select all VMs
• 'f': toggle Filter VMs (by username)
• 'n': rename username
• 'l': toggle view logs

Actions

• p: Pause selected VMs
• r: Resume selected VMs
• 'u': Update VM list
• 's': ssh into selected VM (select just one VM)

📝 Configuration

Edit ~/.surf_controller/config.toml to customize your settings.

🤝 Contributing

Contributions are welcome!

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• Thanks to https://claude.ai/ for help with the curses implementation