Getting Started
Get up and running with SP Toolkit in 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)
- Modern experience enabled
- App Catalog configured (tenant or site collection)
Installation Steps
Download the Package
Download the SP Toolkit solution package (.sppkg file) from the download page. This is a standard SharePoint Framework solution package.
Upload to App Catalog
Navigate to your SharePoint Admin Center and upload the package to your App Catalog.
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.
Activate Your License
Enter your license key in the web part settings to unlock full functionality.
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.Open SP Toolkit and select "Migration Wizard"
- 2.Choose "Same Tenant" migration type
- 3.Enter or browse to your target site URL
- 4.Select the list(s) you want to migrate
- 5.Review field mappings (defaults are usually fine for identical lists)
- 6.Run pre-flight validation to check for issues
- 7.Click "Execute Migration" and monitor progress
- 8.Review results and export any reports
Tip: Always test migrations with a small list first. Use the "Structure Only" mode to create the list schema without data to verify field compatibility.
Next Steps
Field Types Reference
Understand how different SharePoint field types are handled during migration.
View Reference →