Installation Guide

Installation Guide

Prerequisites

Before installing FLEXON, ensure you have:

• .NET 6.0 SDK or later
• Visual Studio 2019 or later (recommended)
• Git (for source installation)

Installation Methods

1. NuGet Package

The easiest way to install FLEXON is via NuGet:

# Package Manager Console
Install-Package FlexonCLI

# .NET CLI
dotnet add package FlexonCLI

2. Source Installation

To build from source:

# Clone the repository
git clone https://github.com/LoSkroefie/flexon-cli.git
cd flexon-cli

# Build the solution
dotnet build

# Run tests
dotnet test

# Install globally
dotnet tool install --global --add-source ./nupkg FlexonCLI

Configuration

1. Basic Setup

Add FLEXON to your project:

using FlexonCLI;

// Initialize serializer
var serializer = new FlexonSerializer();

2. ASP.NET Core Integration

In Program.cs or Startup.cs:

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers()
        .AddFlexonFormatters(options =>
        {
            options.EnableCompression = true;
            options.ValidationMode = ValidationMode.Strict;
        });
}

3. Entity Framework Integration

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity<Document>()
        .Property(d => d.Data)
        .HasFlexonConversion();
}

Environment Setup

1. Development Environment

Visual Studio

1. Install Visual Studio 2019 or later
2. Install the ".NET Desktop Development" workload
3. Install the "ASP.NET and web development" workload (optional)

VS Code

1. Install VS Code
2. Install C# extension
3. Install .NET Core Debugger

2. Build Tools

# Install .NET SDK
winget install Microsoft.DotNet.SDK.6

# Install build tools
dotnet tool install -g dotnet-build-tools

3. Environment Variables

Add these to your system environment variables:

FLEXON_HOME=C:\Program Files\FlexonCLI
PATH=%PATH%;%FLEXON_HOME%\bin

Verification

Verify the installation:

# Check CLI version
flexon --version

# Run test serialization
flexon test-connection

Troubleshooting

Common Issues

1. Missing Dependencies

   Error: The type 'FlexonSerializer' could not be found
   

   Solution: Ensure the package is properly referenced in your project file.

2. Version Conflicts

   Error: Could not load file or assembly 'FlexonCLI'
   

   Solution: Check for version conflicts in your dependencies.

3. Path Issues

   'flexon' is not recognized as a command
   

   Solution: Ensure the installation directory is in your PATH.

Installation Logs

Logs are located at:

• Windows: %LOCALAPPDATA%\FlexonCLI\logs
• Linux: ~/.local/share/FlexonCLI/logs
• macOS: ~/Library/Logs/FlexonCLI

Next Steps

1. Follow the Quick Start guide
2. Review Basic Concepts
3. Explore Examples
4. Read the API Reference

Support

For additional help:

• GitHub Issues
• Stack Overflow
• Community Chat