DeadCode.io Documentation

Welcome to the DeadCode.io documentation. This guide will help you understand how to use our platform to detect and eliminate dead code from your codebase.

What is Dead Code?

Dead code refers to any code in your codebase that is never executed during runtime. This includes:

• Unused Functions: Functions that are defined but never called
• Unreachable Code: Code paths that can never be executed due to conditional logic
• Orphaned Imports: Import statements for modules that are never used
• Deprecated Modules: Old code that was replaced but never removed
• Commented Code: Large blocks of commented-out code

Quick Start Guide

Get started with DeadCode.io in just a few minutes. Follow these steps to run your first scan.

Connecting Repositories

DeadCode.io integrates directly with GitHub to scan your repositories. Here's how to connect your repos.

GitHub OAuth

When you sign in with GitHub, you'll be asked to authorize the following permissions:

• repo - Read access to your repositories (required for scanning)
• read:user - Read your profile information
• read:org - See organization membership (for team features)

Selecting Repositories

After signing in, go to Dashboard → Repositories and click "Connect Repository". You can:

• Select individual repositories from the list
• Connect all repositories in an organization
• Filter by language or last activity

Running Scans

Learn how to run scans and configure scanning options for your repositories.

Manual Scans

To run a manual scan:

1. Go to Dashboard → Repositories
2. Click on the repository you want to scan
3. Click the "Scan Now" button
4. Wait for the scan to complete (usually 30-60 seconds)

Automated Scans

Configure automated scans in Settings → Scanning:

Scan Configuration

Customize what gets scanned by creating a .deadcode.yml file in your repository root:

# .deadcode.yml
languages:
  - javascript
  - typescript
  - python

exclude:
  - "node_modules/**"
  - "dist/**"
  - "**/*.test.js"
  - "**/__tests__/**"

severity_threshold: medium  # low, medium, high, critical

Managing Issues

After a scan completes, issues are categorized by type and severity.

Issue Types

Severity Levels

Resolving Issues

For each issue, you can:

• Fix: Remove the dead code from your codebase
• Ignore: Mark as false positive (won't appear in future scans)
• Comment: Add a note explaining why it should remain
• Assign: Assign to a team member to fix

Reports & Analytics

Track your progress in eliminating dead code over time.

Dashboard Metrics

Your dashboard shows key metrics at a glance:

• Total Issues: Number of dead code issues across all repos
• Issues Fixed: Number resolved this month
• Code Health Score: 0-100 score based on dead code ratio
• Trend: Is your codebase getting cleaner over time?

Generating Reports

Go to Reports to generate detailed reports:

• Summary Report: High-level overview for executives
• Detailed Report: Full issue list with code snippets
• Trend Report: Historical data over time
• Team Report: Issues by assignee/team

Reports can be exported as PDF or CSV.

Roles & Permissions

DeadCode.io uses a hierarchical role-based access control (RBAC) system to manage permissions across your organization.

Permission Matrix

Role Descriptions

Team Management

Manage your team members and their access levels.

Inviting Team Members

1. Go to Team → Invite Members
2. Enter their email address
3. Select a role (Developer, Manager, etc.)
4. Click "Send Invite"

Invited users will receive an email with a link to join your organization.

Changing Roles

Admins can change any team member's role:

1. Go to Team → Members
2. Click on the member's name
3. Select a new role from the dropdown
4. Click "Save Changes"

Plans & Pricing

Choose the plan that fits your team's needs. All plans include a 14-day free trial.

Payment Methods

DeadCode.io accepts multiple payment methods through our secure payment processor, Razorpay.

Accepted Payment Methods

• Credit/Debit Cards: Visa, Mastercard, American Express, Rupay
• UPI: Google Pay, PhonePe, Paytm, any UPI app
• Net Banking: All major Indian banks
• Wallets: Paytm, Mobikwik, Freecharge
• International Cards: For non-INR currencies

Managing Payment Methods

To add or update your payment method:

1. Go to Billing → Payment Methods
2. Click "Add Payment Method"
3. Enter your card details or UPI ID
4. Click "Save"

Billing Cycle

Your billing cycle starts on the day you subscribe and renews on the same date each month (or year for annual plans). You'll receive an email reminder 7 days before renewal.

Invoices

Access and download your invoices from the billing dashboard.

Viewing Invoices

1. Go to Billing → Invoices
2. Browse the list of past invoices
3. Click "Download" to get a PDF

Invoice Details

Each invoice includes:

• Invoice number and date
• Billing period
• Plan details and pricing
• Taxes (GST for India)
• Total amount paid
• Payment method used

Tax Information

For Indian customers, GST (18%) is applied to all invoices. To add your GSTIN for tax credits:

1. Go to Billing → Tax Information
2. Enter your GSTIN
3. Click "Save"

Frequently Asked Questions