Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/phmatray/mastercommander
Use your favorite CLI tools without leaving your code editor
https://github.com/phmatray/mastercommander
beta cli developers devops docker dotnet git library npm project-management tool utility workflow-automation
Last synced: about 2 months ago
JSON representation
Use your favorite CLI tools without leaving your code editor
- Host: GitHub
- URL: https://github.com/phmatray/mastercommander
- Owner: phmatray
- License: gpl-3.0
- Created: 2024-01-30T15:08:56.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-16T09:20:57.000Z (6 months ago)
- Last Synced: 2024-12-02T19:51:35.044Z (2 months ago)
- Topics: beta, cli, developers, devops, docker, dotnet, git, library, npm, project-management, tool, utility, workflow-automation
- Language: C#
- Homepage: https://phmatray.github.io/MasterCommander/
- Size: 2.34 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Funding: .github/funding.yml
- License: LICENSE
Awesome Lists containing this project
README
# MasterCommander
Write code, not commands. MasterCommander provides a simple, consistent interface for common development tasks.
|  | MasterCommander is a versatile command-line utility designed to streamline the workflow for developers working with multiple technology stacks. By integrating common operations for Git, .NET, Docker, and npm into a single application, MasterCommander enhances productivity and simplifies project setup and management tasks. |
|---------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
[](https://github.com/phmatray/MasterCommander "Go to GitHub repo")
[](https://www.gnu.org/licenses/gpl-3.0.html)
[](https://github.com/phmatray/MasterCommander)
[](https://github.com/phmatray/MasterCommander)
[](https://github.com/phmatray/MasterCommander/releases/)
[](https://github.com/phmatray/MasterCommander/issues)
[](https://github.com/phmatray/MasterCommander/pulls)
[](https://github.com/phmatray/MasterCommander/graphs/contributors)
[](https://github.com/phmatray/MasterCommander/commits/master)
[](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/phmatray/MasterCommander)
[](https://app.codacy.com/gh/phmatray/MasterCommander/dashboard)
[](https://app.codecov.io/gh/phmatray/MasterCommander/tree/main)
---
## 📝 Table of Contents
* [MasterCommander](#mastercommander)
* [📝 Table of Contents](#-table-of-contents)
* [🏁 Getting started](#-getting-started)
* [📄 Documentation](#-documentation)
* [🌐 User Documentation](#-user-documentation)
* [📚 Technical Documentation](#-technical-documentation)
* [🌍 Contributing to Documentation](#-contributing-to-documentation)
* [📌 Features](#-features)
* [Current Features](#current-features)
* [Roadmap (next features)](#roadmap-next-features)
* [📥 Installation](#-installation)
* [📋 Prerequisites](#-prerequisites)
* [We use the latest C# features](#we-use-the-latest-c-features)
* [🚀 From Source](#-from-source)
* [📦 NuGet Packages](#-nuget-packages)
* [📊 Code Quality](#-code-quality)
* [🧪 Tests Specifications](#-tests-specifications)
* [🤝 Contributing](#-contributing)
* [How to contribute?](#how-to-contribute)
* [Contributors](#contributors)
* [❓ Issues and Feature Requests](#-issues-and-feature-requests)
* [✉️ Contact](#-contact)
* [📜 License](#-license)
---
## 🏁 Getting started
Use your favorite CLI tools without leaving your code editor:
This example demonstrates how to use MasterCommander to create a new .NET solution and project, initialize a Git
repository, and build and run the project.
In addition, this code adds a .gitignore file, an .editorconfig file, and a global.json file to the project.
```csharp
private const string SdkVersion = "8.0.*";
private const string SolutionName = "AppDemo";
private const string ConsoleProjectName = $"{SolutionName}.Console";
private const string ConsoleProjectDirectory = $"src/{ConsoleProjectName}";
private const string ConsoleCsproj = $"{ConsoleProjectDirectory}/{ConsoleProjectName}.csproj";
await git.InitAsync();
await git.StatusAsync();
await dotnet.NewAsync(new DotnetNewGitignoreOptions());
await dotnet.NewAsync(new DotnetNewEditorConfigOptions());
await dotnet.NewAsync(new DotnetNewNuGetConfigOptions());
await dotnet.NewAsync(new DotnetNewGlobalJsonOptions { SdkVersion = SdkVersion });
await dotnet.NewAsync(new DotnetNewSolutionOptions { OutputName = SolutionName });
await dotnet.NewAsync(new DotnetNewConsoleOptions { OutputName = ConsoleProjectName, OutputDirectory = ConsoleProjectDirectory });
await dotnet.SlnAddAsync(ConsoleCsproj);
await git.AddAsync("*");
await dotnet.BuildAsync();
await dotnet.BuildAsync(new DotnetBuildOptions { Configuration = "Release" });
await dotnet.RunAsync(new DotnetRunOptions { Project = ConsoleCsproj, Configuration = "Release" });
```
You can standardize your development workflow by using MasterCommander to perform common tasks across multiple projects
and technology stacks.
Output from MasterCommander commands is displayed in a clean, readable format:
> 
## 📄 Documentation
Explore the extensive documentation to get started with **MasterCommander**, understand its capabilities, and integrate it into your projects effectively. Our documentation is split into two main sections to cater to different needs:
### 🌐 User Documentation
For an overview of **MasterCommander**, including features, installation guides, and how to get started with using the library in your projects, visit our **[User Documentation](https://phmatray.github.io/MasterCommander/mastercommander.html)**. This section is designed to help both beginners and experienced users to quickly leverage the library's full potential.
### 📚 Technical Documentation
For developers looking for in-depth technical details, our **[Technical Documentation](https://github.com/phmatray/MasterCommander/blob/main/docs/README.md)** provides comprehensive insights into the library's internal workings, API references, and code examples. This section is ideal for those who want to extend the library, contribute to its development, or simply understand its mechanisms at a deeper level.
#### 🌍 Contributing to Documentation
Our documentation is written in English to reach a broad audience. We welcome contributions from the community to expand our documentation, including translations into other languages. If you're interested in helping us make **MasterCommander** more accessible by translating the documentation or improving the existing content, please [open an issue](https://github.com/phmatray/MasterCommander/issues) on our GitHub repository to discuss your ideas.
> **Note:** The documentation for **MasterCommander** is generated automatically using the [Doraku/DefaultDocumentation](https://github.com/Doraku/DefaultDocumentation) tool whenever the project is built. This ensures that the documentation is always up-to-date with the latest codebase.
## 📌 Features
### Current Features
* [x] **Unified Interface**: MasterCommander provides a single interface for interacting with multiple development
tools.
* [x] **Simple Commands**: Execute common development tasks with simple, intuitive commands.
* [x] **Cross-Platform**: MasterCommander is designed to work on Windows, macOS, and Linux.
* [x] **Customizable**: Add new commands and features to MasterCommander to suit your workflow.
### Roadmap (next features)
* [ ] **WIP =>** **.NET Projects**: Easily create new .NET solutions and projects.
* [ ] **WIP =>** **Git Integration**: Initialize new repositories, check status, and more with built-in Git commands.
* [ ] **WIP =>** **Docker Support**: Manage Docker containers and images through simple commands.
* [ ] **WIP =>** **npm Packages**: Handle npm packages and run npm scripts within your projects.
* [ ] Comprehensive API documentation that is easy to understand
* [ ] High-Level API for common use cases
* [ ] More tests
* [ ] More examples
* [ ] More features
## 📥 Installation
### 📋 Prerequisites
To use MasterCommander, ensure you have the following installed on your system:
* Git
* .NET 8.0 (supported versions: 8.0.101 or later)
* A C# IDE (Visual Studio, JetBrains Rider, etc.)
* A C# compiler (dotnet CLI, etc.)
* Docker (optional)
* Node.js and npm (optional)
#### We use the latest C# features
This library targets .NET 8.0 and uses the latest C# features. It is written in C# 12.0 and uses the new `init`
properties, `record` types, `switch` expressions, `using` declarations and more.
I invite you to read the [C# 12.0 documentation](https://docs.microsoft.com/en-us/dotnet/csharp/whats-new/csharp-12) to
learn more about these features.
### 🚀 From Source
You can also build MasterCommander from source. Follow these steps to get started:
1. Clone the repository to your local machine.
2. Navigate to the cloned directory and build the project using the .NET CLI: `dotnet build`.
3. Run the application with `dotnet run` from within the source directory.
4. Or... open the project in Visual Studio (or JetBrains Rider) and run the application from the IDE.
### 📦 NuGet Packages
To install MasterCommander, you can use the NuGet package manager. Run the following command in your terminal:
```shell
dotnet add package MasterCommander
```
| Package Name | NuGet Version Badge | NuGet Downloads Badge | Package Explorer |
|-----------------|----------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------|--------------------------------------------------------|
| MasterCommander | [](https://www.nuget.org/packages/MasterCommander) | [](https://www.nuget.org/packages/MasterCommander) | [Explore](https://nuget.info/packages/MasterCommander) |
This table is automatically updated regularly the latest developments and releases.
## 📊 Code Quality
We strive for the highest code quality in MasterCommander. To ensure this, we use the following tools:
* StyleCop
* .editorconfig
### 🧪 Tests Specifications
We use xUnit and FluentAssertions to write and run tests for MasterCommander. This ensures that the library is reliable
and performs as expected.
## 🤝 Contributing
### How to contribute?
Contributions to MasterCommander are welcome! Whether it's reporting bugs, discussing improvements, or submitting pull
requests, all contributions help make MasterCommander a better tool for developers.
Before submitting pull requests, please ensure you have discussed the proposed changes with the project maintainers.
A great way to contribute to MasterCommander is to add new commands. If you have a command you'd like to see added to
MasterCommander, please open an issue to discuss it.
### Contributors
[](http://contrib.rocks)
## ❓ Issues and Feature Requests
For reporting bugs or suggesting new features, kindly submit these as an issue to
the [MasterCommander Repository](https://github.com/phmatray/MasterCommander/issues). We value your contributions, but
before submitting an issue, please ensure it is not a duplicate of an existing one.
## ✉️ Contact
You can contact us by opening an issue on this repository.
## 📜 License
GNU General Public License v3.0 or later.