BccFS – brainCloud Cloud Code File System

BccFS is a Visual Studio Code extension that provides a virtual file system for browsing and editing brainCloud Cloud Code scripts directly within the editor.

🚧 Under active development – Features and behaviors may change.

✨ Features

• Automatically selects the last-used brainCloud team from your portal login.
• Displays brainCloud Apps as top-level folders in the file explorer.
• Lists all Cloud Code scripts for each App.
• Full support for:
  • Creating, opening, saving, deleting, and renaming scripts
  • Switching teams at runtime
• View and edit script metadata (e.g., permissions, author, description).
• Enhanced editing experience with:
  • Code completion for brainCloud services
  • Script validation
• Activity Bar Integration:
  • Displays current connection and workspace status
  • Access features such as:
    • Login and connect to a brainCloud workspace
    • View logged-in user and team information
    • View and edit the server in use
    • Switch between brainCloud teams
    • Reset all client-side data to recover from errors
    • View extension version and open the details page
• Status Bar Integration:
  • Shows:
    • Connection status
    • Server being accessed
    • Extension version
  • When disconnected:
    • Allows reconnection by clicking the status bar
  • When connected:
    • Displays environment and user details
    • Allows logout by clicking the status bar
• Live Apps display a lock indicator in the explorer for script editing:
  • Right-click and select Toggle Lock to change edit mode
  • Local edits are not persisted in locked apps

🚫 Known Limitations

• Moving scripts between Apps or folders is not yet fully implemented.
• Error handling and version conflict detection are still in development.

🚀 Getting Started

NEW

1. Install the BccFS extension from the Visual Studio Code Marketplace.
2. Select the brainCloud icon from the Activity Bar
3. Click Connect to brainCloud to open the file explorer for your selected team.

Alternatively:

1. Install the BccFS extension from the Visual Studio Code Marketplace.
2. Launch VS Code without opening a folder or workspace.
3. Open the Command Palette (F1 or Ctrl+Shift+P) and run:
   > Connect to brainCloud
   (Optionally, save the workspace for future sessions.)
4. Use the Command Palette to access all extension actions at any time.

⚙️ Available Commands

Access all functionality via the Command Palette (F1 or Ctrl+Shift+P) by typing any of the following:

🔧 Workspace & Team Management

• brainCloud: Open Server in Browser
  Opens the configured server host URL in your default web browser.

• brainCloud: Open Workspace
  Initializes a brainCloud workspace. Run this first after installing the extension. (Visible only when not connected)

• brainCloud: Close Workspace
  Closes the active brainCloud session.

• brainCloud: Switch brainCloud Team
  Switch to another team associated with your brainCloud account.

• brainCloud: Edit Server Configuration
  Opens the settings to view or update the current server configuration.

• brainCloud: Logout
  Ends the current brainCloud session.

• brainCloud: Reset Client Info
  Clears local data including selected team, server info, and cache to resolve client-side issues.

• brainCloud: Show Extension Details
  Opens the extension details page in VS Code where you can view the installed version and related metadata.

🧪 Developer & Debug Tools

These are only visible when bccfs.debug is enabled:

• brainCloud: (D) Clear Team
  Clears the currently selected team data.

• brainCloud: (D) Clear Config
  Clears stored configuration settings.

• brainCloud: (D) Clear Cache
  Clears internal extension cache. (Only visible when connected)

📂 Contextual Commands

The following actions are available from various UI elements:

• Toggle Lock
  Right-click on a script file or tab to toggle lock status for live apps. Locked apps will not save local edits.

• Switch brainCloud Team
  Right-click inside the file explorer or click the status bar team entry to switch teams.

• Refresh Script Info
  Use the refresh icon in the brainCloud Script Info panel to reload metadata.

• Edit Script Info
  Click the pencil icon next to any editable script metadata field (e.g., permissions, author, description) in the brainCloud Script Info pane.

🧠 Tips

You can always type brainCloud in the Command Palette to see all available commands and quick actions.

If your client is stuck use the Reset Client Info action, and connect again.

If you modify the server url, it is best to use the Reset Client Info action, and connect again.