← Back to Documentation

Getting Started

Get up and running with SP Toolkit in under 5 minutes. This guide covers installation, initial setup, and your first migration.

Prerequisites

Required Permissions

  • SharePoint Administrator – Required for App Catalog deployment
  • Site Collection Administrator – Required for site-level deployment
  • Read/Write access to source and target lists

Environment Requirements

  • SharePoint Online (Microsoft 365) or Teams
  • Modern experience enabled
  • App Catalog configured (tenant or site collection). Don't have one? Create one in the Admin Center — it takes about 30 minutes to provision.
  • Modern browser (Edge, Chrome, Firefox, or Safari)

Installation Steps

1

Download the Package

Download the SP Toolkit solution package (.sppkg file) from the download page. This is a standard SharePoint Framework solution package.

2

Upload to App Catalog

Navigate to your SharePoint Admin Center and upload the package to your App Catalog.

Go to SharePoint Admin Center → More features → Apps (or go directly to https://<tenant>-admin.sharepoint.com/_layouts/15/online/AdminHome.aspx#/appManagement)
Click App Catalog → Apps for SharePoint
Click Upload and select the .sppkg file
When prompted, check "Make this solution available to all sites" for tenant-wide deployment
3

Add to a SharePoint Page

Navigate to any SharePoint site where you want to use the toolkit and add the web part to a page.

Navigate to a SharePoint site page (or create a new one)
Click Edit to enter edit mode
Click + to add a web part, search for "SP Toolkit"
Save and publish the page
4

Start Your Free Trial

Click "Start Free Trial" to activate a 14-day trial - no credit card required.

From the main hub, select Help & Licensing
Click Start Free Trial to begin your 14-day evaluation
Full access unlocks immediately - start migrating right away!

Your First Migration

We recommend starting with a simple same-tenant migration to familiarize yourself with the workflow.

Quick Start: Same-Tenant Migration

Migrate a list from one site to another within the same tenant.

  1. 1.Open SP Toolkit and select "Migration Wizard"
  2. 2.Choose "Same Tenant" migration type
  3. 3.Enter or browse to your target site URL
  4. 4.Select the list(s) you want to migrate
  5. 5.Review field mappings (defaults are usually fine for identical lists)
  6. 6.Optional: Choose "Structure Only" mode for your first test run to create the list schema without data
  7. 7.Run pre-flight validation to check for issues
  8. 8.Click "Execute Migration" and monitor progress
  9. 9.Review results and export any reports

Looking for cross-tenant migration? Additional Azure app registrations are required. See our Cross-Tenant Migration Guide for full setup instructions.

Tip: Always test migrations with a small list first to verify field compatibility.

Next Steps

Migration Guides

Learn about same-tenant and cross-tenant migration scenarios in depth.

Read Guides →

Field Types Reference

Understand how different SharePoint field types are handled during migration.

View Reference →

AI Features

Discover how AI can help with field mapping, analysis, and optimization.

Explore AI →

Troubleshooting

Solutions for common issues including licensing errors, connectivity, and migration problems.

Get Help →