Skip to content

Installation Guide

Jump to bottom
Adhika P. edited this page Jan 20, 2025 · 1 revision

Installation Guide

Prerequisites

  • .NET SDK 8.0

Global Installation

Install ConfigFern as a global .NET CLI tool:

dotnet tool install --global ConfigFern

Update to the latest version:

dotnet tool update --global ConfigFern

Uninstall if needed:

dotnet tool uninstall --global ConfigFern

Local Installation

Steps

  1. Clone the repository
  2. Build the project:
# Restore dependencies
dotnet restore

# Generate a NuGet package
dotnet pack -c Release

# Create a local tool manifest (if not already exists)
dotnet new tool-manifest

# Install from the generated package
dotnet tool install --local ConfigFern --add-source ./bin/Release

Running Locally

After installation, run the tool using either:

# Using dotnet tool
dotnet configfern [command]

# Or via the local tool path
dotnet tool run configfern [command]

Troubleshooting

If you encounter issues during installation:

  • Verify you have the correct .NET SDK version installed
  • Ensure you're in the project root directory
  • Check that all dependencies are properly restored
  • Try running dotnet restore to resolve dependency issues

Back to Home

Clone this wiki locally