SpikePrimeGit Documentation

Sync your LEGO SPIKE Prime projects to GitHub

🎉 Chrome Extension Approved!

The Chrome Web Store Extension is now live and ready to install!

Available in the Chrome Web Store Get it on GitHub Marketplace

⚠️ GitHub Marketplace Approval Pending: The GitHub Marketplace App approval is currently underway. You won't be able to search for SpikePrimeGit in the GitHub Marketplace yet.

Meanwhile: Advanced users can set up their own GitHub App or explore the project on GitHub.

🌟 New to GitHub? Start Here!

If you're a student, parent, or coach who's never used GitHub before, we've created a special guide just for you!

📚 Read the Beginner's Guide (for Kids & Parents)

Learn what GitHub is, why it's useful, and how this plugin helps - explained in simple terms!

📖 What is SpikePrimeGit?

SpikePrimeGit is a Chrome extension that helps students and coaches automatically save LEGO SPIKE Prime projects to GitHub. This makes it easy to:

  • Version Control: Keep track of changes to your projects over time
  • Backup: Never lose your hard work - everything is safely stored in the cloud
  • Collaboration: Share projects with teammates and coaches
  • Portfolio: Build a portfolio of your robotics projects

✨ Features

  • One-Click Setup: Simple GitHub authentication, no complex configuration
  • Auto-Capture: Automatically detects when you save projects
  • Version Control: Every save creates a Git commit with your custom message
  • Upload Support: Works with both new projects and uploaded .llsp3 files
  • Sync History: Track all your uploads in the popup
  • Privacy First: No data collection, direct GitHub communication
  • Native UI: Integrated sync button and notifications on SPIKE Prime page

📋 What You'll Need

  • Google Chrome browser
  • A GitHub account (free)
  • Access to LEGO SPIKE Prime software
  • About 10-15 minutes for setup

⚙️ Setup Guide - One Time Activity

Follow these steps carefully to set up SpikePrimeGit. Don't worry - you only need to do this once!

1

Install the Chrome Extension

Available in the Chrome Web Store

  1. Click the badge above or visit the Chrome Web Store
  2. Click "Add to Chrome"
  3. Click "Add extension" in the confirmation dialog
  4. You should see the SpikePrimeGit icon appear in your Chrome toolbar
💡 Tip: Pin the extension to your toolbar for easy access by clicking the puzzle icon in Chrome and then the pin icon next to SpikePrimeGit.
2

Create a GitHub Account

If you don't have a GitHub account yet:

  1. Go to github.com/signup
  2. Enter your email address and create a password
  3. Choose a username (this will be visible to others)
  4. Verify your email address
💡 Tip for Coaches: Consider creating a team organization on GitHub to manage student projects in one place.
3

Create a GitHub Repository

A repository is like a folder where your projects will be saved.

  1. Go to github.com/new
  2. Enter a repository name (e.g., "spike-prime-projects")
  3. Choose "Public" or "Private" (Private keeps your code hidden)
  4. Check "Add a README file"
  5. Click "Create repository"
4

Connect to GitHub

Connect the extension to your GitHub account using the SpikePrimeGit GitHub App.

  1. Click the SpikePrimeGit extension icon in Chrome
  2. Click "Connect to GitHub"
  3. You'll be redirected to GitHub to authorize the SpikePrimeGit app
  4. Select the repositories you want to give SpikePrimeGit access to
  5. Click "Install & Authorize"
  6. You'll be redirected back to the extension
Extension before GitHub connection

Extension popup before connecting to GitHub

⚠️ Important: Only grant access to repositories where you want to store your SPIKE Prime projects.
💡 Can't Find the App? If the SpikePrimeGit GitHub App is not yet available on the marketplace, you can create your own GitHub App following our custom setup guide.
5

Configure Your Settings

Now you're connected! Configure where your projects will be saved:

  1. Select your Repository from the dropdown
  2. Select a Branch (usually "main" or "master")
  3. Set a Project Path (e.g., "projects/" - this is where files will be saved in your repository)
  4. Click "Save Settings"
Extension connected screen with settings

Extension popup after connecting to GitHub with settings configured

🎉 Setup Complete!

You're all set! Your SPIKE Prime projects can now sync to GitHub.

🚀 How to Use SpikePrimeGit

Now that you're set up, here's how to use the extension every day.

Syncing Your Projects

The extension integrates directly into the SPIKE Prime interface, making syncing simple:

  1. Open SPIKE Prime software in Chrome
  2. Work on your project as normal
  3. Click "Save" in SPIKE Prime (the extension captures it automatically)
  4. Look for the SpikePrimeGit card on the page (injected by the extension)
  5. Enter a commit message describing your changes in the text area
  6. Click "Sync to GitHub"
  7. Wait for the success notification
SpikePrimeGit sync interface in SPIKE Prime

SpikePrimeGit interface integrated into SPIKE Prime page

💡 Tip: Make sure to save your project in SPIKE Prime first before clicking "Sync to GitHub"!

What Happens When You Sync?

Every sync creates a commit in your GitHub repository with:

  • Your custom commit message
  • The project name
  • A timestamp
  • The complete .llsp3 file

Viewing Your Projects on GitHub

Your projects are saved as .llsp3 files in your repository:

  1. Go to your GitHub repository
  2. Navigate to the folder you specified (e.g., "projects/")
  3. You'll see all your SPIKE Prime projects listed
  4. Click on any project to see when it was last updated
  5. Click on "History" to see the complete history of changes
  6. Download any version to restore it

Typical repository structure:

your-repo/
  └── projects/
      ├── MyRobot.llsp3
      ├── LineFollower.llsp3
      └── CompetitionReady.llsp3

Checking Recent Syncs

To see your recent uploads:

  1. Click the SpikePrimeGit extension icon
  2. Scroll down to "Recent Syncs"
  3. You'll see a list of your recent project uploads with timestamps

🔧 Troubleshooting

"No project captured yet" Error

Problem: You clicked "Sync to GitHub" but no project is captured.

Solutions:

  • Make sure you saved the project in SPIKE Prime first
  • Try saving again (Ctrl+S or Cmd+S)
  • Check the browser console (F12) for detailed logs
  • If you uploaded a file, make sure to save it at least once

Connection Issues

Problem: Extension shows "Not Connected" status.

Solutions:

  • Click the extension icon
  • Click "Connect to GitHub" again
  • Make sure you authorized the GitHub App
  • Check that you selected at least one repository

"Extension context invalidated" Error

Problem: Extension was reloaded while page was open.

Solution:

  • Simply refresh the SPIKE Prime page (F5)
  • The extension will reconnect automatically

Projects Not Appearing on GitHub

Solutions:

  • Check you're looking at the correct branch
  • Verify the project path matches your settings (e.g., "projects/")
  • Check repository commits to see if files are being created
  • Open browser console (F12) and look for errors

How to Add More Repositories

To grant SpikePrimeGit access to additional repositories:

  1. Go to your GitHub App Installations
  2. Click "Configure" next to SpikePrimeGit
  3. Select additional repositories
  4. Click "Save"
  5. Click the refresh button (↻) in the extension popup to reload repositories

How to Start Over

To reset the extension:

  1. Click the extension icon
  2. Click "Disconnect"
  3. Follow the setup steps again

👨‍🏫 Tips for Coaches

Managing Student Projects

Here are some strategies for using SpikePrimeGit with your team:

Option 1: Individual Student Repositories

  • Each student creates their own GitHub account and repository
  • Pros: Students learn to manage their own code
  • Cons: Harder to monitor all students

Option 2: Team Organization (Recommended)

  • Create a GitHub Organization for your team
  • Create one repository per student or per project
  • You (coach) have access to all repositories
  • Pros: Easy to monitor, backup, and manage
  • Cons: Requires initial setup

Best Practices

  • Have students name their projects descriptively (e.g., "line-follower-v2")
  • Encourage regular saves to build up project history
  • Review commit history to see student progress over time
  • Use GitHub Issues to give feedback on projects
  • Create a shared repository for team resources and example code

Privacy Considerations

  • Students under 13 may need parental permission for GitHub accounts
  • Consider using private repositories for student work
  • Remind students not to include personal information in code comments

💬 Need Help?

If you're still having trouble:

  • Check the browser console (F12) for detailed error messages
  • Ask your coach or teacher for help
  • Report issues on the GitHub repository

🔐 Privacy & Security

  • Zero Telemetry - No analytics or tracking
  • Local Storage - Tokens stored securely in your browser
  • Direct Communication - Extension talks directly to GitHub API
  • Open Source - All code available for inspection
  • No Backend - No third-party servers, no data leaves your control

Learn more: Privacy Policy • Authentication & Data Storage