CodeToNeo4j 1.1.16

CodeToNeo4j

CodeToNeo4j is a .NET tool that analyzes .NET solutions and indexes their structure (projects, files, symbols, and documentation) into a Neo4j graph database.

Features

• Multi-File Support: Indexes .cs, .razor, .xaml, .js, .ts, .tsx, .html, .xml, .json, .css, .csproj, and .dart files (configurable via --include).
• Structural Ingestion: Indexes Projects, Files, and Symbols (Classes, Methods, Directives, UI Elements).
• Semantic Metadata: Ingests XML Documentation and code comments for every symbol.
• Incremental Indexing: Only process changed files using --diff-base. When enabled, it also ingests detailed commit history in parallel batches (hashes, authors, dates, and messages) and links them to the modified files. Support for various git range specifications (e.g., hash1..hash2).
• Git Metadata: Tracks file metadata including creation/modification dates, commits, and individual author statistics (contribution counts and dates).
• Administrative Tools: Safely purge data by repository key using --purge-data.
• Accessibility Filtering: Control which members are indexed using --min-accessibility.
• Platform Native Progress: Special progress reporting for GitHub Actions and Azure DevOps.

Installation

Install the tool globally using NuGet:

dotnet tool install --global CodeToNeo4j

Basic Usage

Run the tool by providing Neo4j credentials. When --input is omitted, the tool auto-detects the project type from the current directory:

# .NET solution
codetoneo4j \
  --uri bolt://localhost:7687 \
  --password your-password

Or specify an explicit input:

codetoneo4j \
  --input ./MySolution.sln \
  --uri bolt://localhost:7687 \
  --password your-password

# Dart project directory
codetoneo4j \
  -s ./my-dart-project/ \
  --uri bolt://localhost:7687 \
  --password your-password

Key Options

Note: When --input is omitted, the tool auto-detects the project type from the current directory (.sln > .slnx > .csproj > pubspec.yaml > files-only). When using --purge-data, the tool asks for confirmation before deletion. If --include is specified, only matching file extensions are purged. --skip-dependencies and --min-accessibility are not allowed with this switch. Only one of --log-level, --debug, --verbose, or --quiet can be used.

Purge examples

• Purge by derived repository key:

  codetoneo4j --input ./MySolution.sln --password your-pass --purge-data
  

• Purge all CodeToNeo4j data (when using --no-key):

  codetoneo4j --no-key --password your-pass --purge-data
  

• Purge only certain file types:

  codetoneo4j --input ./MySolution.sln --password your-pass --purge-data --include .cs --include .razor
  

Prerequisites

• .NET 8, 9, or 10 SDK must be installed on the machine.
• Neo4j 5.0+ database.
• Git (if using --diff-base).
• Dart SDK (optional) — required only for analyzing Dart projects. Install from dart.dev/get-dart. The dart executable must be available on your PATH. If not found, .dart files are skipped with a warning.

For more detailed documentation, visit the GitHub Repository.

CI/CD Integration

GitHub Actions

You can install and run CodeToNeo4j directly in your GitHub workflows:

- name: Setup .NET
  uses: actions/setup-dotnet@v4
  with:
    global-json-file: global.json

- name: Install CodeToNeo4j
  run: dotnet tool install --global CodeToNeo4j

- name: Run CodeToNeo4j
  run: |
    codetoneo4j \
      --input ./MySolution.sln \
      --uri ${{ secrets.NEO4J_URL }} \
      --password ${{ secrets.NEO4J_PASS }} \
      --diff-base ${{ github.event.before }}

Azure DevOps

Use the .NET Core task to install and run the tool:

steps:
- task: UseDotNet@2
  inputs:
    packageType: 'sdk'
    useGlobalJson: true

- script: dotnet tool install --global CodeToNeo4j
  displayName: 'Install CodeToNeo4j'

- script: |
    codetoneo4j \
      --input ./MySolution.sln \
      --uri $(NEO4J_URL) \
      --password $(NEO4J_PASS) \
      --diff-base $(System.PullRequest.SourceCommitId)
  displayName: 'Run CodeToNeo4j'