1
1
Fork 0
mirror of https://github.com/goreleaser/nfpm synced 2024-06-09 17:46:06 +02:00

docs: using cobra fork

Signed-off-by: Carlos A Becker <caarlos0@gmail.com>
This commit is contained in:
Carlos A Becker 2021-07-07 01:38:52 +00:00
parent 8a05df1908
commit 330cc48893
No known key found for this signature in database
GPG Key ID: E61E2F7DC14AB940
7 changed files with 65 additions and 28 deletions

View File

@ -16,5 +16,6 @@ nFPM is a simple, 0-dependencies, deb, rpm and apk packager.
* [nfpm completion](/cmd/nfpm_completion/) - generate the autocompletion script for the specified shell
* [nfpm init](/cmd/nfpm_init/) - creates a sample nfpm.yaml config file
* [nfpm jsonschema](/cmd/nfpm_jsonschema/) - creates a JSON schema file
* [nfpm package](/cmd/nfpm_package/) - creates a package based on the given the given config file and flags

View File

@ -11,13 +11,18 @@ This script depends on the 'bash-completion' package.
If it is not installed already, you can install it via your OS's package manager.
To load completions in your current shell session:
$ source <(nfpm completion bash)
$ source <(nfpm completion bash)
To load completions for every new session, execute once:
Linux:
$ nfpm completion bash > /etc/bash_completion.d/nfpm
MacOS:
$ nfpm completion bash > /usr/local/etc/bash_completion.d/nfpm
### Linux:
nfpm completion bash > /etc/bash_completion.d/nfpm
### macOS:
nfpm completion bash > /usr/local/etc/bash_completion.d/nfpm
You will need to start a new shell for this setup to take effect.

View File

@ -8,10 +8,12 @@ generate the autocompletion script for fish
Generate the autocompletion script for the fish shell.
To load completions in your current shell session:
$ nfpm completion fish | source
nfpm completion fish | source
To load completions for every new session, execute once:
$ nfpm completion fish > ~/.config/fish/completions/nfpm.fish
nfpm completion fish > ~/.config/fish/completions/nfpm.fish
You will need to start a new shell for this setup to take effect.

View File

@ -8,7 +8,8 @@ generate the autocompletion script for powershell
Generate the autocompletion script for powershell.
To load completions in your current shell session:
PS C:\> nfpm completion powershell | Out-String | Invoke-Expression
nfpm completion powershell | Out-String | Invoke-Expression
To load completions for every new session, add the output of the above command
to your powershell profile.

View File

@ -10,13 +10,17 @@ Generate the autocompletion script for the zsh shell.
If shell completion is not already enabled in your environment you will need
to enable it. You can execute the following once:
$ echo "autoload -U compinit; compinit" >> ~/.zshrc
echo "autoload -U compinit; compinit" >> ~/.zshrc
To load completions for every new session, execute once:
# Linux:
$ nfpm completion zsh > "${fpath[1]}/_nfpm"
# macOS:
$ nfpm completion zsh > /usr/local/share/zsh/site-functions/_nfpm
### Linux:
nfpm completion zsh > "${fpath[1]}/_nfpm"
### macOS:
nfpm completion zsh > /usr/local/share/zsh/site-functions/_nfpm
You will need to start a new shell for this setup to take effect.

View File

@ -0,0 +1,19 @@
# nfpm jsonschema
creates a JSON schema file
```
nfpm jsonschema [flags]
```
## Options
```
-h, --help help for jsonschema
-o, --output string where to save the json schema (default "-")
```
## See also
* [nfpm](/cmd/nfpm/) - packages apps on RPM, Deb and APK formats based on a YAML configuration file

View File

@ -15,12 +15,12 @@ theme:
include_search_page: false
search_index_only: true
palette:
- media: "(prefers-color-scheme: light)" # Light mode
- media: "(prefers-color-scheme: light)" # Light mode
scheme: default
toggle:
icon: material/lightbulb-outline
name: Switch to light mode
- media: "(prefers-color-scheme: dark)" # Dark mode
- media: "(prefers-color-scheme: dark)" # Dark mode
scheme: slate
primary: light blue
accent: indigo
@ -33,7 +33,7 @@ plugins:
- search:
prebuild_index: python
lang:
- en
- en
- minify:
minify_html: true
@ -45,18 +45,23 @@ extra:
link: https://twitter.com/goreleaser
nav:
- Home: index.md
- install.md
- usage.md
- Command Line Usage:
- nfpm: cmd/nfpm.md
- nfpm init: cmd/nfpm_init.md
- nfpm package: cmd/nfpm_package.md
- nfpm completion: cmd/nfpm_completion.md
- configuration.md
- tips.md
- contributing.md
- sponsors.md
- Home: index.md
- install.md
- usage.md
- Command Line Usage:
- nfpm: cmd/nfpm.md
- nfpm init: cmd/nfpm_init.md
- nfpm package: cmd/nfpm_package.md
- nfpm completion: cmd/nfpm_completion.md
- nfpm completion bash: cmd/nfpm_completion_bash.md
- nfpm completion fish: cmd/nfpm_completion_fish.md
- nfpm completion powershell: cmd/nfpm_completion_powershell.md
- nfpm completion zsh: cmd/nfpm_completion_zsh.md
- nfpm jsonschema: cmd/nfpm_jsonschema.md
- configuration.md
- tips.md
- contributing.md
- sponsors.md
markdown_extensions:
- admonition