Aiursoft CommandFramework

Aiursoft CommandFramework is a framework for building command line tools.

• Auto argument parsing
• Auto help page generation
• Auto version page generation
• Run as service
• Auto dependency injection
• Auto command completion
• Run as a single command app or a nested command app

With this framework, you can build a command line tool with just a few lines of code.

Example project it built:

Nested command app:

• Nuget Ninja
• HappyRecorder

Single command app:

• Static
• Httping
• DotDownload
• Parser
• Dotlang

Background service:

• IPMI Controller

C:\workspace> ninja.exe

Description:
  Nuget Ninja, a tool for detecting dependencies of .NET projects.

Usage:
  Microsoft.NugetNinja [command] [options]

Options:
  -p, --path <path> (REQUIRED)   Path of the projects to be changed.
  --nuget-server <nuget-server>  If you want to use a customized nuget server instead of the official nuget.org, 
  --token <token>                The PAT token which has privilege to access the nuget server.
  -d, --dry-run                  Preview changes without actually making them
  -v, --verbose                  Show detailed log
  -?, -h, --help                 Show help and usage information

Commands:
  all, all-officials  The command to run all officially supported features.
  remove-deprecated   The command to replace all deprecated packages to new packages.
  upgrade-pkg         The command to upgrade all package references to possible latest and avoid conflicts.
  clean-pkg           The command to clean up possible useless package references.
  clean-prj           The command to clean up possible useless project references.

Why this project?

Command-line applications are a great way to automate repetitive tasks or even to be your own productivity tool. But building a command-line application in .NET is not easy. You need to parse the arguments, generate help pages, and so on. This project is designed to help you build a command-line application with just a few lines of code.

How to use

Run the following command to install Aiursoft.CommandFramework to your project from nuget.org:

dotnet add package Aiursoft.CommandFramework

To use it, you need to decide between:

• Single command app
• Nested command app

A single command app is a command line tool that only has one command.

This is useful for something with limited function, like:

• Ping tool
• File download tool
• Web server tool

A nested command app is a command line tool that has multiple commands. like:

• Nuget Ninja

Select the scenario you want to use and follow the instructions.

Download a real sample project

If you want to explore a real project built with this framework, please check Happy Recorder as an example.

More doc

• Write unit tests

How to contribute

There are many ways to contribute to the project: logging bugs, submitting pull requests, reporting issues, and creating suggestions.

Even if you with push rights on the repository, you should create a personal fork and create feature branches there when you need them. This keeps the main repository clean and your workflow cruft out of sight.

We're also interested in your feedback on the future of this project. You can submit a suggestion or feature request through the issue tracker. To make this process more effective, we're asking that these include more information to help define them more clearly.