Prerequisites
Before deploying, make sure you have:
- A valid
linkapp.config.ts with required manifest fields
- A production build in
dist/ (or linkapp will build automatically)
- Authentication credentials (run
npx @linktr.ee/linkapp login first)
Authenticate
Log in to Linktree before your first deployment:
npx @linktr.ee/linkapp login
~/.config/linkapp/auth-token.json.
Deploy your LinkApp
Deploy to production:
Or use the CLI directly:
npx @linktr.ee/linkapp deploy
Deploy to QA
To deploy to the QA environment:
npx @linktr.ee/linkapp deploy --qa
Deployment process
When you run linkapp deploy:
- Validates your project and config
- Builds the app (if needed)
- Uploads to Linktree
Deployment flags
| Flag | Description |
|---|
--qa | Deploy to QA environment instead of production |
--skip-build | Skip building (use existing dist/) |
--skip-checks | Skip pre-deployment validation |
--force | Force deploy even if warnings |
npx @linktr.ee/linkapp deploy --qa --skip-build
After deployment
After a successful deployment, you’ll see:
✓ Deployed successfully!
Build URL: https://linktr.ee/builds/abc123
Test link: https://linktr.ee/test?app=my-app
Next steps:
• View your build in the Linktree dashboard
• Test your LinkApp on a Linktree profile
• Share the build URL with your team
Use the test link to preview your LinkApp on a real Linktree profile before
publishing.
Troubleshooting
Validation errors
If you see config validation errors:
Error: Invalid config
- manifest.title: Required
- manifest.description: Max 200 characters
- settings[0].id: Must be alphanumeric
linkapp.config.ts and redeploy.
Bundle size warnings
If your bundle exceeds 5MB:
⚠ Warning: Bundle size is 6.2MB (exceeds 5MB recommended limit)
Authentication errors
If you see 401 Unauthorized:
npx @linktr.ee/linkapp logout
npx @linktr.ee/linkapp login
Build errors
If the build fails during deployment:
# Build locally to see errors
npx @linktr.ee/linkapp build
# Fix errors, then deploy
npx @linktr.ee/linkapp deploy --skip-build
Config schema errors
Check your config against the schema:
# This will validate during build
npx @linktr.ee/linkapp build
Deployment fails
Enable verbose logging:
DEBUG=linkapp:* npx @linktr.ee/linkapp deploy
Multiple environments
You can maintain separate LinkApps for development and production:
export default {
manifest: {
name: process.env.LINKAPP_ENV === "qa" ? "My App QA" : "My App",
// Generates IDs: "my-app-qa" or "my-app"
},
settings: {
title: process.env.LINKAPP_ENV === "qa" ? "My App (QA)" : "My App",
},
};
LINKAPP_ENV=qa npx @linktr.ee/linkapp deploy --qa
LINKAPP_ENV=prod npx @linktr.ee/linkapp deploy
CI/CD integration
Deploy from CI/CD pipelines:
.github/workflows/deploy.yml
name: Deploy LinkApp
on:
push:
branches: [main]
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: 18
- run: npm install
- run: npm run build
- run: npm run deploy
env:
LINKTREE_TOKEN: ${{ secrets.LINKTREE_TOKEN }}
Store your authentication token as a secret. Never commit auth-token.json or
tokens to version control.
Next steps
