https://github.com/tonerdo/dotget
Installer for .NET Core CLI Apps
https://github.com/tonerdo/dotget
cli-tool csharp dotnetcore installer shipit
Last synced: 7 months ago
JSON representation
Installer for .NET Core CLI Apps
- Host: GitHub
- URL: https://github.com/tonerdo/dotget
- Owner: tonerdo
- License: mit
- Created: 2017-04-08T08:39:21.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-07-27T19:26:35.000Z (over 7 years ago)
- Last Synced: 2025-03-07T14:16:23.807Z (11 months ago)
- Topics: cli-tool, csharp, dotnetcore, installer, shipit
- Language: C#
- Homepage: https://medium.com/@tonerdo/introducing-dotget-an-installer-for-net-core-cli-apps-9ba79ac7cd89
- Size: 135 KB
- Stars: 35
- Watchers: 8
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# dotGet [](https://ci.appveyor.com/project/tonerdo/dotget) [](LICENSE)
dotGet is a command line installer for cross platform CLI tools built with .NET Core. dotGet makes your .NET Core command line tools, distributed via NuGet, available for use via the system path.
## Installation
### Prerequisites
Install [.NET Core](https://www.microsoft.com/net/download/core)
### Windows
```powershell
(new-object Net.WebClient).DownloadString("https://raw.githubusercontent.com/tonerdo/dotget/master/scripts/install.ps1") | iex
```
### Unix
```shell
curl -s https://raw.githubusercontent.com/tonerdo/dotget/master/scripts/install.sh | bash
```
_Note: Ensure that $HOME/.dotget/bin has been added to your path after installation_
## Usage
To see a list of commands, run:
```shell
dotnet get --help
```
The current commands are (output from `dotnet get --help`):
```shell
.NET Core Tools Global Installer 1.0.0.0
Usage: dotnet get [options] [command]
Options:
-h|--help Show help information
-v|--version Show version information
--verbose Enable verbose output
Commands:
install Installs a .NET Core tool
list Lists all installed .NET Core tools
uninstall Uninstalls a .NET Core tool
update Updates a .NET Core tool
Use "dotnet get [command] --help" for more information about a command.
```
### Installing a tool
To install a .NET Core tool, simply run:
```shell
dotnet get install [@version]
```
`source` in this case is a published NuGet package with the following structure:
```shell
├── build
├── content
├── lib
├── tools
│ └── netcoreapp*.*
│ └── .deps.json
│ └── .runtimeconfig.json
│ └── .dll
│ └── .dll
│ └── .dll
└── .nuspec
```
* The NuGet package *must* contain a `tools` folder (the other folders are completely optional for dotGet)
* The `tools` folder should have at least one sub-folder with a .NET Core App moniker (e.g `netcoreapp2.0`)
* The contents of the `netcoreapp*.*` folder should be a published [framework dependent](https://docs.microsoft.com/en-us/dotnet/core/deploying/) .NET Core app.
* The `netcoreapp*.*` folder can contain multiple framework dependent .NET Core apps.
After installation the command `` will now be available from the system path and invoking that will execute the .NET Core app.
### Updating a tool
To update an already installed .NET Core tool, simply run:
```shell
dotnet get update
```
### Updating dotGet
To update dotGet itself, you just need to run the `update` command without including a ``, like so:
```shell
dotnet get update
```
### Listing installed tools
To get a list of all installed .NET Core tools, simply run:
```shell
dotnet get list
```
### Uninstalling a tool
To remove a .NET Core tool, you simply run:
```shell
dotnet get uninstall
```
## Issues & Contributions
If you find a bug or have a feature request, please report them at this repository's issues section. Contributions are highly welcome, however, except for very small changes, kindly file an issue and let's have a discussion before you open a pull request.
## License
This project is licensed under the MIT license. See the [LICENSE](LICENSE) file for more info.