- Notifications
You must be signed in to change notification settings - Fork0
Tool to publish & distribute CLI tools
License
termapps/publisher
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Tool to publish & distribute CLI tools
NOTE: Only supports tools hosted in GitHub for now.
Setup publishing configuration.(Only needed for first time setup).
publisher initSetup your CI pipeline to build release artifacts.(Only needed for first time setup).
publisher generate ciUpdate your code, commit and push to repository with a version tag.
git tag v1.0.0git push --tagsCheck that you meet all requirements for publishing to configuredpackage repositories.
publisher checkRun the following to publish a version to configuredpackage repositories.
publisher publish 1.0.0Discover more subcommands and options.
publisher helpUsed for installing the built binary:
Used for building from source:
publisher is available on Linux, macOS & Windows
WithCargo
cargo install publisherWithHomebrew
brew install termapps/tap/publisherWithAUR (binary)
yay -S publisherWithScoop
scoop bucket add termapps https://github.com/termapps/scoop-bucketscoop install publisherWithNix
nix profile install github:termapps/nixpkgs#publisherPre-built binary executables are available atreleases page.
Download, unarchive the binary, and then put the executable in$PATH.
Publisher can be configured usingpublisher.toml file. The below options are avaialable:
| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes1 | Name of the binary |
description | string | Yes1 | Description of the project |
homepage | string | Yes1 | URL of the project homepage |
license | string | Yes1 | License |
repository | string | Yes | URI of the GitHub repository (ex: termapps/publisher) |
exclude | string[] | No | Package Repository selection |
homebrew | object | Yes | Homebrew |
aur | object | No | AUR |
aur_bin | object | No | AUR (binary) |
scoop | object | Yes | Scoop |
nix | object | No | Nix |
| Name | Type | Required | Description |
|---|---|---|---|
name | string | No | Name of the formula |
repository | string | Yes | GitHub repository for the homebrew tap |
namedefaults to the binary name.
| Name | Type | Required | Description |
|---|---|---|---|
name | string | No | Name of the package |
conflicts | string[] | No | Packages in AUR that conflict with this |
namedefaults to the binary name.- Automatically adds
AUR (binary)package toconflictsif it is selected.
| Name | Type | Required | Description |
|---|---|---|---|
name | string | No | Name of the package |
conflicts | string[] | No | Packages in AUR that conflict with this |
namedefaults to the binary name concatenated with-bin.- Automatically adds
AURpackage toconflictsif it is selected.
| Name | Type | Required | Description |
|---|---|---|---|
name | string | No | Name of the app |
repository | string | Yes | GitHub repository for the scoop bucket |
namedefaults to the binary name.
| Name | Type | Required | Description |
|---|---|---|---|
name | string | No | Name of the package |
repository | string | No | GitHub repository for the nix package |
path | string | No | Path of the package in the repo |
lockfile | bool | No | Whether to update flake lockfile |
namedefaults to the binary name.repositorydefaults to binary's GitHub repository.pathdefaults toflake.nix.%ncan be used inpathto substitute with name. For example,%n/flake.nixcreates the package atpublisher/flake.nixlocation.lockfiledefaults totrueand is needed to install the package most of the time.
- By default, all the availablepackage repositories are selected if not specified in the subcommand.
- If
excludeis configured, then those will be excluded from the above selected package repositories.
Here is a list ofContributors
Please seeCHANGELOG.md.
MIT/X11
Reporthere.
Pavan Kumar Sunkara (pavan.sss1991@gmail.com)
Footnotes
About
Tool to publish & distribute CLI tools