Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/weihanli/dotnet-exec
dotnet execute with custom entry point, another dotnet run without project file
https://github.com/weihanli/dotnet-exec
csharp csharp-script dotnet dotnet-exec dotnet-execute dotnet-script execute script
Last synced: about 1 month ago
JSON representation
dotnet execute with custom entry point, another dotnet run without project file
- Host: GitHub
- URL: https://github.com/weihanli/dotnet-exec
- Owner: WeihanLi
- License: apache-2.0
- Created: 2022-05-03T16:27:14.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-14T04:17:10.000Z (10 months ago)
- Last Synced: 2024-04-14T05:38:03.777Z (10 months ago)
- Topics: csharp, csharp-script, dotnet, dotnet-exec, dotnet-execute, dotnet-script, execute, script
- Language: C#
- Homepage:
- Size: 5.04 MB
- Stars: 41
- Watchers: 3
- Forks: 4
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# dotnet-exec
Package | Latest | Latest Preview
---- | ---- | ----
dotnet-execute | [](https://www.nuget.org/packages/dotnet-execute/) | [](https://www.nuget.org/packages/dotnet-execute/absoluteLatest)
ReferenceResolver | [](https://www.nuget.org/packages/ReferenceResolver/) | [](https://www.nuget.org/packages/ReferenceResolver/absoluteLatest)
[](https://github.com/WeihanLi/dotnet-exec/actions/workflows/dotnet.yml)
[](https://hub.docker.com/r/weihanli/dotnet-exec)
[](https://builtwithdot.net/project/5741/dotnet-exec)
[中文介绍](./README.zh-CN.md)
## Intro
`dotnet-exec` is a command-line tool for executing C# program without a project file, and you can have your custom entry point other than the `Main` method
Slides:
- [Makes C# more simple -- .NET Conf China 2022](https://github.com/WeihanLi/dotnet-exec/blob/main/docs/slides/dotnet-conf-china-2022-dotnet-exec_makes_csharp_more_simple.pdf)
- [dotnet-exec simpler C# -- .NET Conf China 2023 Watch Party Shanghai](https://github.com/WeihanLi/dotnet-exec/blob/main/docs/slides/dotnet-exec-simpler-csharp.pdf)
Github Action for executing without dotnet environment
-
-
## Install/Update
### dotnet tool
Latest stable version:
```sh
dotnet tool update -g dotnet-execute
```
Latest preview version:
```sh
dotnet tool update -g dotnet-execute --prerelease
```
Install failed? try the command below:
```sh
dotnet tool update -g dotnet-execute --source https://api.nuget.org/v3/index.json
```
```sh
dotnet tool update -g dotnet-execute --prerelease --add-source https://api.nuget.org/v3/index.json --ignore-failed-sources
```
Uninstall or failed to update? Try uninstall and install again
```sh
dotnet tool uninstall -g dotnet-execute
```
### Container support
Execute with docker
``` sh
docker run --rm weihanli/dotnet-exec:latest "1+1"
```
``` sh
docker run --rm weihanli/dotnet-exec:latest "Guid.NewGuid()"
```
``` sh
docker run --rm --pull=always weihanli/dotnet-exec:latest "ApplicationHelper.RuntimeInfo"
```
Execute with podman
``` sh
podman run --rm weihanli/dotnet-exec:latest "1+1"
```
``` sh
podman run --rm weihanli/dotnet-exec:latest "Guid.NewGuid()"
```
``` sh
podman run --rm --pull=always weihanli/dotnet-exec:latest "ApplicationHelper.RuntimeInfo"
```
for the full image tag list, see
## Examples
### Get started
Execute local file:
``` sh
dotnet-exec HttpPathJsonSample.cs
```
Execute a local file with custom entry point:
``` sh
dotnet-exec 'HttpPathJsonSample.cs' --entry MainTest
```
Execute remote file:
``` sh
dotnet-exec https://github.com/WeihanLi/SamplesInPractice/blob/master/net7Sample/Net7Sample/ArgumentExceptionSample.cs
```
Execute raw code:
``` sh
dotnet-exec 'Console.WriteLine(1+1);'
```
Execute the raw script:
```sh
dotnet-exec '1 + 1'
```
``` sh
dotnet-exec 'Guid.NewGuid()'
```
### References
Execute raw code with custom references:
NuGet package reference:
``` sh
dotnet-exec 'CsvHelper.GetCsvText(new[]{1,2,3}).Dump();' -r "nuget: WeihanLi.Npoi,2.5.0" -u "WeihanLi.Npoi"
```
Local dll reference:
``` sh
dotnet-exec 'CsvHelper.GetCsvText(new[]{1,2,3}).Dump();' -r "./out/WeihanLi.Npoi.dll" -u "WeihanLi.Npoi"
```
Local dll in a folder references:
``` sh
dotnet-exec 'CsvHelper.GetCsvText(new[]{1,2,3}).Dump();' -r "folder: ./out" -u "WeihanLi.Npoi"
```
Local project reference:
``` sh
dotnet-exec 'CsvHelper.GetCsvText(new[]{1,2,3}).Dump();' -r "project: ./WeihanLi.Npoi.csproj" -u "WeihanLi.Npoi"
```
Framework reference:
``` sh
dotnet-exec 'WebApplication.Create().Run();' --reference 'framework:web'
```
Web framework reference in one option:
``` sh
dotnet-exec 'WebApplication.Create().Run();' --web
```
### Usings
Execute raw code with custom usings:
``` sh
dotnet-exec 'WriteLine(1+1);' --using "static System.Console"
```
Execute script with custom reference:
``` sh
dotnet-exec 'CsvHelper.GetCsvText(new[]{1,2,3}).Dump()' -r "nuget:WeihanLi.Npoi,2.5.0" -u WeihanLi.Npoi
```
### More
Execute with additional dependencies
``` sh
dotnet-exec 'typeof(LocalType).FullName.Dump();' --ad FileLocalType2.cs
```
``` sh
dotnet-exec 'typeof(LocalType).FullName.Dump();' --addition FileLocalType2.cs
```
Execute with exacting references and usings from the project file
``` sh
dotnet-exec 'typeof(LocalType).FullName.Dump();' --project ./Sample.csproj
```
Execute file with preview features:
``` sh
dotnet-exec RawStringLiteral.cs --preview
```
### Config Profile
You can customize the config you used often into a config profile to reuse it for convenience.
List the profiles had configured:
``` sh
dotnet-exec profile ls
```
Configure a profile:
``` sh
dotnet-exec profile set web -r "nuget:WeihanLi.Web.Extensions" -u 'WeihanLi.Web.Extensions' --web --wide false
```
Get the profile details:
``` sh
dotnet-exec profile get web
```
Remove the profile not needed:
``` sh
dotnet-exec profile rm web
```
Executing with specific profile config:
``` sh
dotnet-exec 'WebApplication.Create().Chain(_=>_.MapRuntimeInfo()).Run();' --profile web --using 'WeihanLi.Extensions'
```
Executing with specific profile config and remove preset specific using:
``` sh
dotnet-exec 'WebApplication.Create().Run();' --profile web --using '-WeihanLi.Extensions'
```
## Acknowledgements
- [Roslyn](https://github.com/dotnet/roslyn)
- [NuGet.Clients](https://github.com/NuGet/NuGet.Client)
- [System.CommandLine](https://github.com/dotnet/command-line-api)
- [Thanks JetBrains for the open source Rider license](https://jb.gg/OpenSource?from=dotnet-exec)
- Many thanks to the contributors and users for this project