> ## Documentation Index
> Fetch the complete documentation index at: https://docs.depfixer.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Get started with DepFixer in 30 seconds

# Quickstart

## Prerequisites

* Node.js 18 or higher
* A JavaScript/TypeScript project with a `package.json`

## Installation

### Option 1: Use npx (no install)

```bash theme={null}
npx depfixer
```

### Option 2: Install globally

```bash theme={null}
npm install -g depfixer
```

Then run:

```bash theme={null}
depfixer
```

## Step 1: Run DepFixer

Open your terminal in your project directory and run `depfixer` (or `npx depfixer`).

## Step 2: Review the Analysis

DepFixer will display the ASCII logo and scan your dependencies:

```
  ██████╗  ███████╗ ██████╗ ███████╗██╗██╗  ██╗███████╗██████╗
  ██╔══██╗ ██╔════╝ ██╔══██╗██╔════╝██║╚██╗██╔╝██╔════╝██╔══██╗
  ██║  ██║ █████╗   ██████╔╝█████╗  ██║ ╚███╔╝ █████╗  ██████╔╝
  ██║  ██║ ██╔══╝   ██╔═══╝ ██╔══╝  ██║ ██╔██╗ ██╔══╝  ██╔══██╗
  ██████╔╝ ███████╗ ██║     ██║     ██║██╔╝ ██╗███████╗██║  ██║
  ╚═════╝  ╚══════╝ ╚═╝     ╚═╝     ╚═╝╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝
           Dependency Hell? We've Got the Cure.

⚡ DepFixer CLI v1.0.0
──────────────────────────────────────────────────

📦 PROJECT: my-angular-app
   Framework: Angular

✓ Analysis complete

📊 ANALYSIS REPORT
──────────────────────────────────────────────────
🏥 Health:  [████████░░] 72/100 (WARNING)
⚠️  Issues:  10 Conflicts Found
```

## Step 3: Review Issues

For smaller issue counts, you'll see a severity breakdown:

```
SEVERITY BREAKDOWN
--------------------------------------------------
  CRITICAL   1 issue require attention
  HIGH       3 issues with compatibility problems
  MEDIUM     2 issues with version conflicts
  LOW        4 issues to review
    Unlock to see details and recommended fixes.
```

## Step 4: Unlock Solutions

If issues are found, you'll see a cost box:

```
+--------------------------------------------------+
|                                                  |
|  COST TO ANALYZE:   15 CREDITS                   |
|  PLAN SIZE:         Tier: Small                  |
|                                                  |
+--------------------------------------------------+
[?] Continue to login? (Enter/Esc)
```

Press `Enter` to proceed.

## Step 5: Authenticate

First-time users will see the device code flow:

```
🔐 DEVICE CODE LOGIN
──────────────────────────────────────────────────

    Your verification code:

          ABCD-1234

    Opening browser to complete login...
    Waiting for authorization...
```

Enter the code in your browser to authenticate.

## Step 6: Apply Fixes

Once authenticated with sufficient credits, you'll see the full solution:

```
🔓 FULL ANALYSIS
──────────────────────────────────────────────────

PACKAGE                            CURRENT       TARGET        TYPE
---------------------------------------------------------------------------
@angular/core                      16.0.0        17.3.0        Major
@angular/cli                       16.0.0        17.3.0        Major
typescript                         4.9.5         5.4.5         Major
rxjs                               7.5.0         7.8.1         Minor

────────────────────────────────────────
  📝 Only package.json will be modified
  💾 A backup (package.json.bak) will be created
────────────────────────────────────────

Apply fix to package.json? (Enter/Esc)
```

Press `Enter` to apply.

## Step 7: Done!

```
✨ SUCCESS
──────────────────────────────────────────────────

    ✓ 4 Packages Updated
    ✓ Backup: package.json.bak

    👉 NEXT STEP:
    Run the following command to finalize changes:

    $ npm install
```

Run `npm install` to install the updated dependencies.

## Other Ways to Use DepFixer

### GitHub Action

Automatically check dependencies on every pull request:

```yaml .github/workflows/depfixer.yml theme={null}
name: Dependency Check
on: [pull_request]

jobs:
  depfixer:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: depfixer/action@v1
        with:
          api-key: ${{ secrets.DEPFIXER_API_KEY }}
```

See the [GitHub Action guide](/guides/github-action) for full configuration options.

### MCP Server (AI IDE Integration)

Use DepFixer tools directly in Claude Code, Cursor, or Windsurf:

```bash theme={null}
npx @depfixer/mcp-server
```

Then ask your AI assistant: "Analyze my package.json for dependency issues"

See the [MCP Server guide](/guides/mcp-setup) for setup instructions.
