VocGit Studio

A VS Code extension providing an integrated GUI for Vocareum Publisher (vocgit) - the CLI tool for publishing course content to Vocareum.

Prerequisites

You must install the vocgit CLI separately before using this extension:

npm install -g vocareum-publisher

Or if using the GitHub Action workflow, vocgit is installed automatically in CI/CD.

Features

• Quick Actions Panel - One-click buttons for common operations:

  • Push to Vocareum
  • Pull from Vocareum
  • Check Status
  • Validate Configuration
  • Set VOCAREUM_API_KEY

• Configuration Tree View - Visual representation of your vocareum.yaml:

  • Browse courses, assignments, and parts
  • Click to open folders in Explorer
  • Right-click assignments to push individually
  • Inline "Go to Teacher IDE" action on each part (opens Vocareum teacher editor in browser)
  • Expand parts to see files (startercode, scripts, etc.)
  • Sync status indicators in the tree:
    • assignment-level pending publish marker
    • part-level inherited pending marker
    • directory-level changed/unknown/error marker

• YAML Schema Validation - Autocomplete and error checking for vocareum.yaml

• Secure API Key Handling - API keys are stored in VS Code Secret Storage and passed via environment variables

Setup

1. Install the vocgit CLI: npm install -g vocareum-publisher

2. Configure your API key using Command Palette:

   • Run VocGit: Set VOCAREUM_API_KEY
   • Enter your Vocareum API key when prompted

   Legacy vocgit.apiKey settings are still read for backward compatibility, but are deprecated.

3. Create a vocareum.yaml in your project root (see vocgit documentation for schema)

Usage

1. Click the VocGit icon in the Activity Bar (left sidebar)
2. Use the action buttons to push, pull, check status, validate, or set VOCAREUM_API_KEY
3. Browse your course structure in the Configuration tree
4. Right-click an assignment to push just that assignment

Extension Settings

| Setting | Description | |---------|-------------| | vocgit.apiKey | Deprecated fallback setting (use VocGit: Set VOCAREUM_API_KEY) |

Requirements

• VS Code 1.80.0 or higher
• vocgit CLI installed and available in PATH
• A valid vocareum.yaml configuration file
• Extension package version in this repo: 1.0.1

Links

• vocgit CLI Documentation
• Report Issues