dotnet-execute 0.31.0

dotnet-exec

A powerful command-line tool for executing C# programs without project files, featuring custom entry points, REPL mode, comprehensive reference management, and integrated testing capabilities.

🎯 Overview

dotnet-exec simplifies C# development by allowing you to:

• Execute C# code directly from command line or files
• Use custom entry points beyond the traditional Main method
• Access REPL mode for interactive C# development
• Reference NuGet packages, local DLLs, and frameworks seamlessly
• Run xUnit tests without project setup
• Save configurations as reusable profiles
• Create aliases for frequently used commands
• Work with remote scripts via URLs

📦 Package Information

Package	Latest	Latest Preview
dotnet-execute
ReferenceResolver

📖 Documentation: English | 中文介绍

🚀 Quick Start

Installation

# Install latest stable version
dotnet tool install -g dotnet-execute

# Install latest preview version
dotnet tool install -g dotnet-execute --prerelease

# Update to latest version
dotnet tool update -g dotnet-execute

Basic Usage

# Execute simple expressions
dotnet-exec "1 + 1"
dotnet-exec "Guid.NewGuid()"
dotnet-exec "DateTime.Now"

# Execute C# statements
dotnet-exec 'Console.WriteLine("Hello, dotnet-exec!");'

# Execute script files
dotnet-exec MyScript.cs

# Execute remote scripts
dotnet-exec https://raw.githubusercontent.com/user/repo/main/script.cs

# Start REPL mode
dotnet-exec

✨ Key Features

🎯 Multiple Execution Modes

• Raw Code: Execute C# expressions and statements directly
• Script Files: Run local .cs files with custom entry points
• Remote Scripts: Execute scripts from URLs
• REPL Mode: Interactive C# development environment

📚 Rich Reference Support

• NuGet Packages: Latest or specific versions
• Local Assemblies: DLL files and folder references
• Project References: Inherit dependencies from .csproj files
• Framework References: Web, desktop, and custom frameworks

🧪 Integrated Testing

• xUnit Integration: Run tests without project setup
• Test Discovery: Automatic test method detection
• Custom References: Add packages for testing scenarios

⚙️ Configuration Management

• Profiles: Save and reuse common configurations
• Aliases: Create shortcuts for frequent commands
• Environment Variables: Set execution context

🛠️ Developer-Friendly

• Custom Entry Points: Use methods beyond Main
• Preview Features: Access latest C# language features
• Debug Mode: Detailed compilation and execution information
• Container Support: Docker/Podman execution without .NET SDK

📖 Usage Examples

Basic Execution

# Simple calculations
dotnet-exec "Math.Sqrt(16)"
dotnet-exec "string.Join(\", \", new[] {\"a\", \"b\", \"c\"})"

# Working with dates
dotnet-exec "DateTime.Now.AddDays(7).ToString(\"yyyy-MM-dd\")"

# File operations
dotnet-exec "Directory.GetFiles(\".\", \"*.cs\").Length"

Script Files with Custom Entry Points

Create example.cs:

public class Example
{
    public static void MainTest()
    {
        Console.WriteLine("Custom entry point executed!");
    }
    
    public static void Execute()
    {
        Console.WriteLine("Alternative entry method");
    }
}

# Use custom entry point
dotnet-exec example.cs --entry MainTest

# Use default entry method fallbacks
dotnet-exec example.cs --default-entry MainTest Execute Run

References and Using Statements

# NuGet package references
dotnet-exec 'JsonConvert.SerializeObject(new {name="test"})' \
  -r 'nuget:Newtonsoft.Json' \
  -u 'Newtonsoft.Json'

# Multiple references
dotnet-exec MyScript.cs \
  -r 'nuget:Serilog' \
  -r 'nuget:AutoMapper' \
  -u 'Serilog' \
  -u 'AutoMapper'

# Local DLL references
dotnet-exec MyScript.cs -r './libs/MyLibrary.dll'

# Framework references
dotnet-exec 'WebApplication.Create().Run();' --web

REPL Mode

# Start interactive mode
dotnet-exec

# In REPL:
> #r "nuget:Newtonsoft.Json"
> using Newtonsoft.Json;
> var obj = new { Name = "Test", Value = 42 };
> JsonConvert.SerializeObject(obj)
"{"Name":"Test","Value":42}"

Testing

Execute xUnit tests without project setup:

# Run test file
dotnet-exec test MyTests.cs

# Run multiple test files
dotnet-exec test Test1.cs Test2.cs Test3.cs

# Run tests with additional references
dotnet-exec test MyTests.cs \
  -r 'nuget:Moq' \
  -r 'nuget:FluentAssertions' \
  -u 'Moq' \
  -u 'FluentAssertions'

Example test file:

public class CalculatorTests
{
    [Fact]
    public void Add_TwoNumbers_ReturnsSum()
    {
        var result = 2 + 3;
        Assert.Equal(5, result);
    }
    
    [Theory]
    [InlineData(1, 2, 3)]
    [InlineData(0, 0, 0)]
    [InlineData(-1, 1, 0)]
    public void Add_VariousInputs_ReturnsExpected(int a, int b, int expected)
    {
        var result = a + b;
        Assert.Equal(expected, result);
    }
}

Configuration Profiles

Save common configurations for reuse:

# Create a web development profile
dotnet-exec profile set webdev \
  --web \
  -r 'nuget:Swashbuckle.AspNetCore' \
  -r 'nuget:AutoMapper' \
  -u 'AutoMapper'

# List profiles
dotnet-exec profile ls

# Use profile
dotnet-exec MyWebScript.cs --profile webdev

# Get profile details
dotnet-exec profile get webdev

# Remove profile
dotnet-exec profile rm webdev

Command Aliases

Create shortcuts for frequently used commands:

# Create aliases
dotnet-exec alias set guid "Guid.NewGuid()"
dotnet-exec alias set now "DateTime.Now"
dotnet-exec alias set hash "Convert.ToHexString(SHA256.HashData(Encoding.UTF8.GetBytes(args[0])))"

# List aliases
dotnet-exec alias ls

# Use aliases
dotnet-exec guid
dotnet-exec now
dotnet-exec hash "text to hash"

# Remove alias
dotnet-exec alias unset guid

Container Support

Execute with Docker/Podman without .NET SDK:

# Docker
docker run --rm weihanli/dotnet-exec:latest "1+1"
docker run --rm weihanli/dotnet-exec:latest "Guid.NewGuid()"
docker run --rm weihanli/dotnet-exec:latest "DateTime.Now"

# Podman
podman run --rm weihanli/dotnet-exec:latest "1+1"

# Mount local files
docker run --rm -v $(pwd):/workspace weihanli/dotnet-exec:latest MyScript.cs

For the full image tag list, see https://hub.docker.com/r/weihanli/dotnet-exec/tags

📚 Documentation

Comprehensive Guides

• Getting Started: Installation, basic usage, and core concepts
• Advanced Usage: Complex scenarios and advanced features
• References Guide: Managing assemblies, packages, and dependencies
• Profiles and Aliases: Configuration management and shortcuts
• Testing Guide: xUnit integration and testing workflows
• Examples and Use Cases: Real-world examples across different domains
• Troubleshooting: Common issues and solutions

Quick Reference

# Get help
dotnet-exec --help
dotnet-exec profile --help
dotnet-exec alias --help
dotnet-exec test --help

# System information
dotnet-exec --info

🎤 Presentations

• Makes C# more simple -- .NET Conf China 2022
• dotnet-exec simpler C# -- .NET Conf China 2023 Watch Party Shanghai

🔗 GitHub Actions Integration

Execute C# code in CI/CD without .NET SDK setup:

• Repository: https://github.com/WeihanLi/dotnet-exec-action
• Marketplace: https://github.com/marketplace/actions/dotnet-exec

Example usage:

- name: Execute C# Script
  uses: WeihanLi/dotnet-exec-action@main
  with:
    script: 'Console.WriteLine("Hello from GitHub Actions!");'

🙏 Acknowledgements

• Roslyn - C# compiler and analysis APIs
• NuGet.Clients - Package management
• System.CommandLine - Command-line interface
• Thanks JetBrains for the open source Rider license
• Many thanks to all contributors and users of this project

📄 License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

🐛 Issues & Support

• Report bugs: GitHub Issues
• Ask questions: GitHub Issues
• Documentation: Comprehensive Guides

---

⭐ If you find this project helpful, please consider giving it a star!