diff --git a/CONTEXT.md b/CONTEXT.md index a439918..9ff2ce2 100644 --- a/CONTEXT.md +++ b/CONTEXT.md @@ -21,7 +21,7 @@ The managed type in namespace `GitHub` whose `ResolvePath` returns the Payload's _Avoid_: Gh, Ghx, GitHubCli, ResolveBinaryPath **gh** (tool package): -The passthrough .NET tool. Package id `gh` so `dnx`/`ndnx gh`. `ToolCommandName` is `dotnet-gh`, so a locally/globally installed tool is `dotnet gh` and does not steal the `gh` command from GitHub's native CLI. +The passthrough .NET tool. Package id `gh` so `dnx`/`ndx gh`. `ToolCommandName` is `dotnet-gh`, so a locally/globally installed tool is `dotnet gh` and does not steal the `gh` command from GitHub's native CLI. _Avoid_: installing a command named `gh`; wrapping with its own GitHub verbs **Execute**: diff --git a/docs/adr/0002-nupkg-version-is-upstream.md b/docs/adr/0002-nupkg-version-is-upstream.md index 347828b..96807c1 100644 --- a/docs/adr/0002-nupkg-version-is-upstream.md +++ b/docs/adr/0002-nupkg-version-is-upstream.md @@ -1,3 +1,3 @@ # Nupkg version is Upstream -`gh.cli` and the `gh` tool use the GitHub CLI version (`2.98.0`) so `ndnx gh@2.98.0` is that CLI. The pin is `github-cli.version`. CI dogfood stays `42.42.*`. Packaging-only republishes of the same CLI use a SemVer label, not a different major. +`gh.cli` and the `gh` tool use the GitHub CLI version (`2.98.0`) so `ndx gh@2.98.0` is that CLI. The pin is `github-cli.version`. CI dogfood stays `42.42.*`. Packaging-only republishes of the same CLI use a SemVer label, not a different major. diff --git a/readme.md b/readme.md index cd8e65f..9b44c5b 100644 --- a/readme.md +++ b/readme.md @@ -19,19 +19,19 @@ OSMF tier. A single fee covers all of [Devlooped packages](https://www.nuget.org -Packs the [GitHub CLI](https://github.com/cli/cli) for install-less, portable execution via `ndnx`/`dnx`. +Packs the [GitHub CLI](https://github.com/cli/cli) for install-less, portable execution via `ndx`/`dnx`. ## Usage ```bash -ndnx gh repo list +ndx gh repo list dnx gh repo list # installed dotnet tool install gh && dotnet gh --version ``` -`dnx`/`ndnx` use the package id `gh`. An installed tool is `dotnet gh` (`ToolCommandName` `dotnet-gh`) so it does not replace GitHub's native `gh` on PATH. +`dnx`/`ndx` use the package id `gh`. An installed tool is `dotnet gh` (`ToolCommandName` `dotnet-gh`) so it does not replace GitHub's native `gh` on PATH. `PackageReference` `gh.cli` and pack/publish for your RID to copy `gh/` next to the app. `GitHub.Cli.ResolvePath()` is the Payload `gh` executable. diff --git a/src/gh/gh.csproj b/src/gh/gh.csproj index a830334..2fc8874 100644 --- a/src/gh/gh.csproj +++ b/src/gh/gh.csproj @@ -5,7 +5,7 @@ gh gh dotnet-gh - Execute the bundled GitHub CLI. ndnx gh / dnx gh / dotnet gh. + Execute the bundled GitHub CLI. ndx gh / dnx gh / dotnet gh. true true dotnet-gh