| name | lindy-upgrade-migration |
| description | Guide for upgrading Lindy SDK and migrating between versions.
Use when upgrading SDK versions, migrating agents,
or handling breaking changes.
Trigger with phrases like "upgrade lindy", "lindy migration",
"lindy breaking changes", "update lindy SDK".
|
| allowed-tools | Read, Write, Edit, Bash(npm:*) |
| version | 1.0.0 |
| license | MIT |
| author | Jeremy Longshore <jeremy@intentsolutions.io> |
Lindy Upgrade & Migration
Overview
Guide for safely upgrading Lindy SDK versions and migrating configurations.
Prerequisites
- Current SDK version identified
- Changelog reviewed for target version
- Backup of current configuration
- Test environment available
Instructions
Step 1: Check Current Version
npm list @lindy-ai/sdk
npm view @lindy-ai/sdk version
npm view @lindy-ai/sdk changelog
Step 2: Review Breaking Changes
Step 3: Update Dependencies
npm install @lindy-ai/sdk@latest
npm install @lindy-ai/sdk@2.0.0
npm ls @lindy-ai/sdk
Step 4: Update Code
import Lindy from '@lindy-ai/sdk';
const client = new Lindy(process.env.LINDY_API_KEY);
const result = await client.runAgent('agt_123', 'Hello');
import { Lindy } from '@lindy-ai/sdk';
const client = new Lindy({ apiKey: process.env.LINDY_API_KEY });
const result = await client.agents.run('agt_123', { input: 'Hello' });
Step 5: Run Migration Tests
import { Lindy } from '@lindy-ai/sdk';
describe('SDK Migration', () => {
const lindy = new Lindy({ apiKey: process.env.LINDY_API_KEY });
test('client initialization works', async () => {
const user = await lindy.users.me();
expect(user.email).toBeDefined();
});
test('agent operations work', async () => {
const agents = await lindy.agents.list();
expect(Array.isArray(agents)).toBe(true);
});
test('run operations work', async () => {
const result = await lindy.agents.run('agt_test', {
input: 'Test migration',
});
expect(result.output).toBeDefined();
});
});
Migration Checklist
[ ] Backup current configuration
[ ] Review changelog for breaking changes
[ ] Update package.json
[ ] Run npm install
[ ] Update import statements
[ ] Update client initialization
[ ] Update method calls
[ ] Run test suite
[ ] Test in staging environment
[ ] Deploy to production
[ ] Monitor for issues
Output
- Updated SDK to target version
- Migrated code patterns
- Passing test suite
- Documented changes
Error Handling
| Issue | Cause | Solution |
|---|
| Import error | Named exports changed | Check new import syntax |
| Type error | Interface changed | Update TypeScript types |
| Runtime error | Method signature changed | Check new API |
Examples
Automated Migration Script
#!/bin/bash
echo "Starting Lindy SDK migration..."
cp package.json package.json.backup
cp -r src src.backup
npm install @lindy-ai/sdk@latest
npm test
if [ $? -eq 0 ]; then
echo "Migration successful!"
rm -rf src.backup package.json.backup
else
echo "Migration failed. Rolling back..."
mv package.json.backup package.json
rm -rf src && mv src.backup src
npm install
exit 1
fi
Resources
Next Steps
Proceed to Pro tier skills for advanced features.