LogFix Documentation

🌐 Option 1: Web Interface (Recommended)

The fastest way to get started. No installation required!

1. Sign in with GitHub or GitLab
2. Choose your plan (Starter €19 or Pro €29/month)
3. Go to Analysis page
4. Paste your error log and click "Analyze Log"
5. Get AI-powered fixes and create Pull Requests automatically!

⚡ Option 2: CLI (For CI/CD)

npm install -g logfix

logfix auth lf_sk_your_api_key_here

logfix analyze --file error.log --type ci_build --stack node

API Keys

All API requests require authentication using an API key. Your API key identifies you and grants access to your account.

API keys follow the format: lf_sk_ followed by 48 hexadecimal characters.

Using API Keys in Requests

Include your API key in the Authorization header of every request:

Authorization: Bearer lf_sk_your_api_key_here

Creating API Keys

1. Sign in to your Logfix account
2. Navigate to Dashboard → API Keys
3. Click "Create API Key"
4. Give your key a descriptive name (e.g., "CI Production")
5. Copy the key immediately - you won't be able to see it again!

What are Context Files?

Context Files are additional files you provide to help the AI understand your project structure and generate more accurate fixes. This dramatically improves the quality of Pull Requests and reduces false positives.

How to Use (Web Interface)

1. Go to Analysis page
2. Click "📁 Context Files (Optional)"
3. Choose "Upload Files" or "From Repository"
4. Select relevant files (see recommendations below)
5. Proceed with your log analysis

Recommended Files

Example: Before vs After

Supported Formats

Upload up to 10 files, 1MB max per file:

Analyze Logs

Analyze error logs and get AI-powered fixes. This is the main endpoint for log analysis.

Example request:

curl -X POST https://api.logfix.dev/api/v1/analyze \

  -H "Authorization: Bearer lf_sk_your_api_key" \

  -H "Content-Type: application/json" \

  -d '{"logContent": "Error: Cannot find module 'express'"}'

Request Body

The request body must be a JSON object with the following fields:

{
  "logContent": "string (required, min 10 chars)",
  "logType": "ci_build | runtime | client | container | server | database | iac (optional)",
  "stack": "auto | node | python | java | go | rust | php | ruby | dotnet | flutter | react_native | ios | android (optional)",
  "contextFiles": [
    {
      "path": "package.json",
      "content": "{ \"name\": \"app\", \"dependencies\": {...} }"
    }
  ] (optional),
  "errorFileContent": "string (optional)",
  "language": "javascript | typescript | python | java | go | rust | php | ruby | csharp (optional)",
  "additionalContext": "string (optional)"
}

Success Response (200)

A successful response contains the analysis and fix:

{
  "success": true,
  "analysis": {
    "severity": "critical",
    "summary": "Missing dependency in package.json",
    "root_cause": "Express module imported but not installed",
    "confidence_score": 95
  },
  "summary": "Missing Express.js dependency",
  "explanation": "The error occurs because 'express' is imported but not in package.json",
  "fix": "Add express to dependencies and run npm install",
  "remediation": {
    "strategy": "create_pr",
    "prData": {
      "title": "fix(deps): add missing express dependency",
      "body": "This PR adds the missing express dependency to package.json",
      "branchName": "logfix/add-express-dependency",
      "targetRepo": "owner/repo",
      "files": [
        {
          "path": "package.json",
          "content": "{ \"name\": \"app\", \"dependencies\": { \"express\": \"^4.18.0\" } }"
        }
      ]
    }
  },
  "patch": {
    "file_path": "package.json",
    "action": "overwrite",
    "content": "{ \"name\": \"app\", \"dependencies\": { \"express\": \"^4.18.0\" } }"
  },
  "creditsUsed": 1,
  "creditsRemaining": 49
}

Error Responses

{
  "success": false,
  "error": "Invalid API key"
}

{
  "success": false,
  "error": "Insufficient credits"
}

{
  "success": false,
  "error": "Invalid request data",
  "details": {
    "logContent": ["Log content must be at least 10 characters"]
  }
}

🚀 Quick Setup (User)

As a user, setup is super simple - no OAuth app creation needed:

1. Go to Dashboard → API Keys
2. In the "Auto-PR Creation" section, click "Connect GitHub" or "Connect GitLab"
3. Authorize LogFix to access your repositories
4. You're ready! The badge will show "Connected" ✅

⚙️ Admin Setup (Self-Hosted)

For self-hosted instances, admins need to configure OAuth apps:

📋 How It Works (Dashboard)

1. Analyze a log in Analysis page
   • Paste your error log
   • Optionally add Context Files for better accuracy
   • Select log type and stack
2. AI generates remediation with strategy create_pr
   • The "🔧 Remediation" section appears
   • Shows code preview and PR details
3. Review and customize
   • Edit PR title and branch name if needed
   • Review the files that will be modified
4. Enter repository details
   • GitHub: owner/repo (e.g., "johndoe/my-app")
   • GitLab: project ID (e.g., "namespace/project" or numeric ID)
5. Create PR/MR
   • Click "Create Pull Request" or "Create Merge Request"
   • LogFix creates branch, commits files, opens PR/MR
   • ✅ Success! Link opens to the PR/MR on GitHub/GitLab

🖥️ CLI Usage (CI/CD Integration)

Use the CLI in your CI/CD pipelines to analyze build failures automatically:

logfix analyze --file error.log --type ci_build --stack node

- name: Analyze build errors
  if: failure()
  run: |
    npm install -g logfix
    logfix auth ${{ secrets.LOGFIX_API_KEY }}
    logfix analyze --file build.log --type ci_build --stack node

💡 Tip: The CLI shows the analysis and remediation. For PR creation, use the dashboard for better security and UX.

🔗 Supported Providers

💡 Auto-detection: LogFix automatically detects the provider from your repository URL

Log Types

Specify the log type to help the AI understand the context and generate better solutions:

Tech Stacks

Specify your tech stack for more accurate code suggestions. Use "auto" for automatic detection.

Remediation Strategies

Based on the log type and context, the AI chooses the best remediation strategy:

Example Error Handling

try {
  const response = await fetch('https://api.logfix.dev/api/v1/analyze', {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer lf_sk_your_key',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({ logContent: '...' })
  });

  const data = await response.json();

  if (!response.ok) {
    if (response.status === 401) {
      throw new Error('Invalid API key');
    } else if (response.status === 402) {
      throw new Error('Insufficient credits');
    } else {
      throw new Error(data.error || 'Request failed');
    }
  }

  if (data.success && data.patch) {
    // Apply the fix
    applyPatch(data.patch);
  }
} catch (error) {
  console.error('Logfix API error:', error);
}

Credits System

Each log analysis consumes 1 credit. Credits are consumed based on your plan:

• Starter Plan: Uses credit balance (purchase credits as needed)
• Pro Plan: Uses monthly allowance first, then credit balance if exceeded

Rate Limits

Rate limits prevent abuse and ensure fair usage:

If you exceed the rate limit, you'll receive a 429 Too Many Requests error. Wait before retrying.