Vibesweep

API Integration

🚧 Coming soon!

The Vibesweep API will allow you to integrate code analysis directly into your applications and workflows.

Planned Features

REST API

  • Analyze endpoints for on-demand analysis
  • Webhook support for CI/CD integration
  • Batch processing for multiple repositories
  • Real-time results streaming
  • Historical data access

SDK Support

Planned SDKs for:

  • JavaScript/TypeScript
  • Python
  • Go
  • Ruby
  • Java

Example Usage (Coming Soon)

import { VibesweepClient } from '@vibesweep/sdk';

const client = new VibesweepClient({
  apiKey: process.env.VIBESWEEP_API_KEY
});

// Analyze a repository
const results = await client.analyze({
  repo: 'github.com/user/repo',
  branch: 'main',
  options: {
    onlyAiPatterns: true
  }
});

// Get historical trends
const trends = await client.getTrends({
  repo: 'github.com/user/repo',
  period: '30d'
});

Webhook Integration (Coming Soon)

// Receive analysis results
app.post('/webhooks/vibesweep', (req, res) => {
  const { event, data } = req.body;
  
  if (event === 'analysis.completed') {
    console.log(`Waste detected: ${data.wastePercentage}%`);
    // Update dashboard, send alerts, etc.
  }
});

Use Cases

  • Custom dashboards showing code quality metrics
  • Automated reporting for stakeholders
  • Quality gates in deployment pipelines
  • Trend analysis across multiple projects
  • Team performance tracking

Stay tuned for API access!

Related