Home

Welcome to the Typin wiki!

Typin is a simple to use, yet powerful framework for building both interactive command line applications and command line tools. It is build based on the source code of CliFx.

Etymology: Typin is made out of "Typ" for "Type" and "in" for "interactively". It's pronounced as "Type in".

Setup

Install the package via NuGet: dotnet add package Typin

What next?

See: Typin concepts and basic app and advanced features

Versioning

Typin follows Semantic Versioning 2.0.0

Contribute

There's still a good deal of work to be done to make Typin great. If you want to help, please comment on or open an issue, or contribute.

CliFx

Since Typin has its roots in CliFx you may also be interested in this simpler CLI Framework.

Differences between Typin and Clifx:

Interactive mode with auto-completion, parameter escaping with ", and support for user-defined shortcuts,
Middleware pipeline,
Custom directives,
Build-in DI support with Microsoft.Extensions.DependencyInjection that is used accross entire framework,
IOptionFallbackProvider for custom fallback providers instead of only environment variable fallback,
Ability to modify exception handling messages,
DI injectable ICliContext with lots of useful data,
Negative numbers handling,
Manual property in CommandAttribute that can be used to provide a long, extended description of a commmand
(more coming soon).