Clysh 2.3.0
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package Clysh --version 2.3.0
NuGet\Install-Package Clysh -Version 2.3.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Clysh" Version="2.3.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Clysh --version 2.3.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Clysh, 2.3.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Clysh as a Cake Addin
#addin nuget:?package=Clysh&version=2.3.0
// Install Clysh as a Cake Tool
#tool nuget:?package=Clysh&version=2.3.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Clysh
CLi in Yaml for SHell apps
Create your own CLI on .NET 6+ with simple steps.
Release Notes
- 2.2.0 - NEW: IgnoreParent action execution flag AND introduce IClyshAction interface
- 2.3.0 - NEW: Introduce IClyshCommand interface for unit tests again
What is?
Clysh is a library to create a .NET Command Line Interface (CLI). The main goal is to create your own CLI with only business code.
Features
Clysh has some features to facilitate the process of create a CLI.
- You can write your own CLI as an YAML or JSON file. The file is parsed at runtime.
- Easy to make a command tree. You can nest commands to run in a specific order;
- The commands can have custom options with your own shortcuts;
- The options can have required and/or optional parameter to some user data input.
- You can group options like a radio button.
- The help command is auto-generated.
- Easy to mocking for unit tests.
- 2.0 NEW: Global options feature to reuse option structure with N commands
Getting Started
To use Clysh you need to install the package from NuGet.
dotnet add package clysh
The project of example app is available on GitHub
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net6.0 is compatible. 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. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net6.0
- Newtonsoft.Json (>= 13.0.1)
- System.IO.Abstractions (>= 17.0.15)
- YamlDotNet (>= 11.2.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated | |
---|---|---|---|
2.6.3 | 248 | 3/17/2023 | |
2.6.2 | 212 | 3/17/2023 | |
2.6.1 | 217 | 3/17/2023 | |
2.6.0 | 200 | 3/16/2023 | |
2.5.0 | 217 | 3/9/2023 | |
2.4.0 | 216 | 3/7/2023 | |
2.3.1 | 198 | 3/6/2023 | |
2.3.0 | 216 | 3/5/2023 | |
2.2.0 | 231 | 3/5/2023 | |
2.1.0 | 270 | 2/7/2023 | |
2.0.1 | 302 | 2/3/2023 | |
2.0.0 | 279 | 2/3/2023 | |
1.4.1 | 309 | 1/14/2023 | |
1.4.0 | 390 | 8/16/2022 | |
1.3.6 | 441 | 8/12/2022 | |
1.3.5 | 446 | 8/8/2022 | |
1.3.4 | 412 | 8/7/2022 | |
1.3.3 | 433 | 8/2/2022 | |
1.3.2 | 428 | 8/2/2022 | |
1.3.1 | 451 | 8/2/2022 | |
1.3.0 | 443 | 7/24/2022 | |
1.2.0 | 425 | 7/21/2022 | |
1.1.0 | 440 | 7/18/2022 | |
1.0.9 | 446 | 7/6/2022 | |
1.0.8 | 481 | 6/25/2022 | |
1.0.7 | 462 | 6/25/2022 | |
1.0.6 | 453 | 6/22/2022 | |
1.0.5 | 431 | 6/22/2022 | |
1.0.4 | 468 | 6/11/2022 | |
1.0.3 | 462 | 6/11/2022 | |
1.0.2 | 450 | 6/11/2022 |