ATech.Ring.DotNet.Cli 1.1.9

There is a newer version of this package available.
See the version list below for details.
dotnet tool install --global ATech.Ring.DotNet.Cli --version 1.1.9
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest # if you are setting up this repo
dotnet tool install --local ATech.Ring.DotNet.Cli --version 1.1.9
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=ATech.Ring.DotNet.Cli&version=1.1.9
nuke :add-package ATech.Ring.DotNet.Cli --version 1.1.9

ring! - one ring to rule them all...

Ring brings order into the messy world of developing and debugging a cloud-ready microservice system side by side with maintaining and migrating legacy ones where you may have many different types of services (ASP.NET Core, Topshelf, WCF) hosted in many different ways (IIS Express, WindowsService, Exe) and scattered across many solutions and repositories.

What is it?

Ring consists of the following part:

How it works

Ring groups runnables (mostly services but not only) into workspaces. Workspaces are defined in TOML files. Workspaces are composed from runnables and other workspaces. A workspace can be loaded and started. Ring periodically runs a health check for every runnable, tries restarting the unhealthy ones, and reports the dead ones. Ring also exposes a web socket interface. Visual Studio extensions use it mainly for visualizing workspace/runnables states, turning services off/on for build/debugging if they're a part of the currently loaded project/solution.

Basic facts

  • There is only one Ring instance on your dev machine running at a time
  • There can be multiple clients (VS/VS Code extensions) interacting with Ring at a time although mostly you'd have just one
  • Ring is meant to keep your workspace running even if you quit Visual Studio
  • You can also run Ring in a stand-alone mode which just keeps your workspace running
  • Ring exposes a web socket interface on port 7999

Installation

Ring dotnet tool

dotnet tool install --global ATech.Ring.DotNet.Cli --version 1.1.9

Visual Studio Extension

Make sure you installed the dotnet tool first.

Download here ring! for Visual Studio

Visual Studio Code Extension

Download an early preview

Troubleshooting

If ring does not work as expected you can use --debug or -d switch to enable a debug level output.

ring run -w .\path\to\your\workspace.toml -d

Vocabulary

  • runnable - usually a service. Currently the following types are supported:

    • iisexpress - WCF and other services hosted in IIS Express
    • aspnetcore - .NET Core apps running in console
    • netexe - full .NET Framework console apps (like TopShelf)
    • dockercompose - docker-compose files
  • workspace - a logical grouping of runnables defined in TOML file(s). Workspaces can be composed of other workspaces using the import tag. Ring can only run a single workspace at a time. Example workspace:

# your workspace.toml
[[iisexpress]]
csproj = "path/to/your/amazing.name.cool.csproj"

[[iisexpress]]
csproj = "path/to/your/another.name.csproj"

[[import]]
path = "../a/relative/path/to/your/workspace.toml"

Authoring workspaces

Workspaces are written in TOML and they mostly use the arrays of tables to define workspace's components. The following syntax is supported:

Imports another workspace

[[import]]
path = "path/to/another/workspace.toml"

Runs IIS Express hosted full .NET Framework service (e.g. AspNet MVC or WCF)

[[iisexpress]]
csproj = "path/to/your/project.csproj"

Runs full .NET Framework executable project

[[netexe]]
csproj = "path/to/your/project.csproj"

Runs NET Core web project (e.g. AspNet Core MVC)

[[aspnetcore]]
csproj = "/path/to/your/project.csproj"

Runs Docker Compose file

[[dockercompose]]
path = "path/to/docker-compose.yml"

Comments

# This is a comment
# [[aspnetcore]]
# csproj = "/path/to/your/project.csproj"

If the same service is declared multiple times in imported workspaces they will be deduplicated and only one instance of a service (based on the project path) will be launched.

How to contribute

Coming soon

Release notes

1.1.9

  • Logging improvements.

1.1.8

  • Fixed System.ArgumentOutOfRangeException if runnable is dead.

1.1.7

  • Fixed swallowing exceptions if one of the base tasks fails.
  • Fixed Microsoft.AspNetCore.WebSockets reference.

1.1.6

  • Added support for docker-compose files
  • Fixed a bug on capturing output of exited processes
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.2 is compatible.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last updated
5.1.0-alpha.1 83 1/16/2024
5.0.0 200 1/14/2024
5.0.0-alpha.1 49 1/13/2024
4.3.0 132 1/12/2024
4.3.0-alpha.2 55 1/12/2024
4.3.0-alpha.1 53 1/12/2024
4.2.0 205 12/8/2023
4.1.0 136 12/8/2023
4.1.0-alpha.2 63 12/6/2023
4.1.0-alpha.1 61 12/6/2023
4.0.1 153 12/6/2023
4.0.1-alpha.4 64 12/5/2023
4.0.1-alpha.3 64 12/5/2023
4.0.1-alpha.2 66 12/4/2023
4.0.1-alpha.1 63 12/4/2023
4.0.0 182 6/23/2023
4.0.0-beta.4 89 5/7/2023
4.0.0-beta.3 85 5/3/2023
4.0.0-beta.2 80 5/3/2023
4.0.0-beta.1 88 3/7/2023
4.0.0-alpha.9 92 11/1/2022
4.0.0-alpha.8 97 11/1/2022
4.0.0-alpha.7 108 10/28/2022
4.0.0-alpha.6 105 10/28/2022
4.0.0-alpha.5 102 9/1/2022
4.0.0-alpha.4 102 8/23/2022
4.0.0-alpha.3 94 8/23/2022
4.0.0-alpha.2 94 8/23/2022
4.0.0-alpha.1 105 8/22/2022
3.2.0-alpha.2 109 8/19/2022
3.2.0-alpha.1 106 8/19/2022
3.1.2 452 1/3/2022
3.1.2-alpha.4 131 1/3/2022
3.1.2-alpha.3 126 1/3/2022
3.1.2-alpha.2 121 1/3/2022
3.1.2-alpha.1 125 1/3/2022
3.1.1 291 12/31/2021
3.1.1-alpha.1 116 12/31/2021
3.1.0 280 12/30/2021
3.0.1-alpha.1 129 12/13/2021
3.0.0-alpha.1 1,059 11/28/2021
2.5.1 390 11/11/2021
2.5.0 335 11/11/2021
2.5.0-alpha.2 198 9/12/2021
2.5.0-alpha.1 182 9/10/2021
2.4.4 391 9/9/2021
2.4.4-pre.3 139 2/26/2021
2.4.4-pre.2 149 2/5/2021
2.4.4-pre.1 187 2/3/2021
2.4.3 465 1/25/2021
2.4.3-pre.1 182 1/15/2021
2.4.2 507 1/10/2021
2.4.2-pre.10 286 11/24/2020
2.4.2-pre.9 202 11/23/2020
2.4.2-pre.8 220 11/17/2020
2.4.2-pre.7 227 11/17/2020
2.4.2-pre.6 215 11/17/2020
2.4.2-pre.5 226 11/16/2020
2.4.2-pre.4 243 11/12/2020
2.4.2-pre.3 257 10/30/2020
2.4.2-pre.2 206 10/29/2020
2.4.2-pre.1 238 10/26/2020
2.4.1 479 10/13/2020
2.4.1-pre.6 241 10/5/2020
2.4.1-pre.5 260 10/5/2020
2.4.1-pre.4 242 10/3/2020
2.4.1-pre.3 239 10/3/2020
2.4.1-pre.1 266 10/3/2020
2.4.0 557 9/22/2020
2.4.0-pre.12 276 9/22/2020
2.4.0-pre.11 282 9/17/2020
2.4.0-pre.10 297 9/16/2020
2.4.0-pre.9 302 9/16/2020
2.4.0-pre.8 313 9/9/2020
2.4.0-pre.7 287 9/2/2020
2.4.0-pre.6 246 9/1/2020
2.4.0-pre.5 235 8/28/2020
2.4.0-pre.4 231 8/27/2020
2.4.0-pre.3 235 8/27/2020
2.4.0-pre.2 233 8/27/2020
2.4.0-pre.1 307 7/9/2020
2.3.5-pre.1 236 8/28/2020
2.3.4 616 6/11/2020
2.3.4-pre 513 4/8/2020
2.3.3-pre 447 4/2/2020
2.3.2-pre 497 3/20/2020
2.3.1-pre 561 3/20/2020
2.3.0-pre 546 3/20/2020
2.2.1-pre 472 1/29/2020
2.2.0-pre 475 1/27/2020
2.1.0-pre 497 1/17/2020
2.0.0 739 9/25/2019
1.1.10 687 9/22/2019
1.1.9 638 9/17/2019
1.1.8 670 9/17/2019
1.1.7 661 9/17/2019
1.1.5-beta 2,097 7/22/2019
1.1.4-beta 595 7/9/2019
1.1.3-beta 561 7/8/2019
1.1.2-beta 587 6/12/2019
1.1.1-beta 655 6/7/2019
1.1.0-beta 586 6/3/2019
1.0.0-beta 620 5/20/2019

* Logging improvements.