Connect Repository
Create a new repository or connect an existing one from the KiCad plugin.
Create a New Repository
Start fresh with a new Paplix repository:
Step 1: Open Create Dialog
- Open KiCad
- Click Paplix → New Project
Step 2: Configure Repository
- Enter a project name (e.g., "power-supply-v2")
- Add an optional description
- Choose visibility:
- Public - Anyone can view
- Private - Only you and collaborators can access
- Click Create
Step 3: Add Your Files
- The plugin creates a new project directory
- Save your KiCad project files to this directory
- Use Paplix → Sync to push your initial files
Connect an Existing Repository
Clone a repository from Paplix:
Step 1: Open Clone Dialog
- Open KiCad
- Click Paplix → Clone Project
Step 2: Select Repository
- Browse your available repositories
- Or search by name
- Select the repository you want to clone
Step 3: Choose Location
- Select a local directory for the project
- Click Clone
- Wait for the files to download
Step 4: Open Project
- Navigate to the cloned directory
- Open the
.kicad_profile in KiCad - Start working!
Connect Existing Local Project
If you have a KiCad project that's not yet on Paplix:
Step 1: Create Repository
- Click Paplix → New Project
- Enter the project name
- Create the repository
Step 2: Move Files
- Copy your existing KiCad files into the new project directory
- Or initialize the repository in your existing project folder
Step 3: Initial Sync
- Click Paplix → Sync
- Enter a commit message like "Initial import"
- Push your files
Repository Settings
After connecting, you can configure:
Default Branch
The main branch for your project (usually main or master).
Collaborators
Add team members from the Paplix web interface:
- Go to your project on paplix.io
- Navigate to Settings → Collaborators
- Add team members by username or email
Webhooks
Configure notifications for changes:
- Go to Settings → Webhooks on Paplix
- Add webhook URLs for integrations
- Select which events trigger notifications
Multiple Repositories
The plugin supports working with multiple repositories:
- Clone multiple projects to different directories
- Switch between them by opening different
.kicad_profiles - Each project syncs independently
Troubleshooting
Repository Not Appearing
- Ensure you're logged in to the correct account
- Refresh the repository list
- Check your permissions on Paplix
Clone Fails
- Verify the repository exists and you have access
- Check your internet connection
- Ensure the target directory is empty or doesn't exist
Sync Errors
- Make sure all KiCad files are saved
- Close any editors that might lock files
- Check for merge conflicts
Next Steps
- Typical Workflow - Learn how to work with your connected repository
- Merge Requests - Collaborate with your team