Faaaster Remote Development

Connect to your WordPress sites with one click via secure SSH tunnels

Faaaster Remote Development extension brings seamless remote development to your WordPress sites hosted on Faaaster. Connect instantly, edit files directly, and develop with the full power of VS Code.

Features

🚀 One-Click Connection

• Browse all your WordPress sites in the sidebar
• Click to connect - that's it!
• Automatic tunnel management

🔐 Secure by Default

• Firebase authentication
• Credentials stored in system keychain (macOS Keychain, Windows Credential Manager)
• Encrypted tunnels via Cloudflare Access
• Service tokens never persisted

⚡ Dev Mode Management

• Enable/disable dev mode directly from VS Code
• Automatic tunnel wake-up
• Resource-efficient auto-sleep when inactive

🎯 Smart Integration

• Works with VS Code and Cursor
• Integrates with VS Code Remote - SSH
• Status bar shows active connections
• Tree view with real-time status

Quick Start

1. Install the extension

   • Search "Faaaster Remote" in Extensions
   • Click Install

2. Login

   • Click the Faaaster icon in Activity Bar
   • Click "Login to Faaaster"
   • Authenticate in your browser

3. Connect

   • Select your site from the list
   • Click the Connect icon
   • VS Code opens in a new window, connected to your site!

Requirements

• VS Code 1.80.0 or higher (or Cursor)
• VS Code Remote - SSH extension
• Active Faaaster account
• Internet connection

Usage

Connecting to a Site

1. Open the Faaaster sidebar
2. Find your site in the list
3. If dev mode is enabled (green icon), click "Connect"
4. If dev mode is disabled (gray icon), click "Enable Dev Mode" first

Managing Dev Mode

Enable Dev Mode:

• Right-click a site → "Enable Dev Mode"
• Wait ~2 minutes for tunnel creation
• Site icon turns green when ready

Disable Dev Mode:

• Right-click a site → "Disable Dev Mode"
• Saves resources when not developing

Disconnecting

• Use Command Palette (Cmd+Shift+P)
• Type "Faaaster: Disconnect"
• Or close the remote VS Code window

Commands

Access via Command Palette (Cmd+Shift+P):

• Faaaster: Login - Authenticate with Faaaster
• Faaaster: Logout - Clear credentials
• Faaaster: Refresh Sites - Reload sites list
• Faaaster: Connect - Connect to selected site
• Faaaster: Enable Dev Mode - Enable dev mode for site
• Faaaster: Disable Dev Mode - Disable dev mode for site
• Faaaster: Disconnect - Stop active tunnel

Security

What Gets Stored?

• ✅ Firebase auth token (system keychain)
• ✅ User email (system keychain)
• ❌ Service tokens (retrieved at runtime only)
• ❌ SSH passwords (never stored)

How It Works

1. Extension authenticates via Firebase
2. Retrieves temporary service tokens from API
3. Establishes encrypted tunnel via Cloudflare
4. Connects VS Code Remote - SSH through tunnel
5. All traffic encrypted end-to-end

Troubleshooting

Extension not showing sites

• Ensure you're logged in
• Click refresh icon
• Check internet connection

Connection fails

• Verify dev mode is enabled (green icon)
• Wait a moment if tunnel is waking up
• Check VS Code Remote - SSH is installed

Authentication expired

• Run "Faaaster: Login" command
• Re-authenticate in browser

Tunnel timeout

• Tunnel may be sleeping
• Try connecting again (auto-wake)
• Or manually enable dev mode

Configuration

Local Development

To test against a local backend:

1. Open Settings (Cmd+,)
2. Search for "Faaaster"
3. Set:
   • API URL: http://localhost:3000/api
   • Web URL: http://localhost:3000
   • Debug: Enable for verbose logging

Or copy settings from settings.example.json

Debug Mode

Enable debug logging to see:

• API requests and responses
• Cloudflared command and output
• Tunnel connection details

Support

• 📖 Documentation
• 🐛 Report Issues
• 💬 Community

Privacy

This extension:

• Only communicates with Faaaster API
• Stores credentials locally in system keychain
• Does not collect telemetry
• Does not share data with third parties

License

MIT - See LICENSE file for details