1
1
Fork 0
mirror of https://github.com/goreleaser/nfpm synced 2024-05-13 15:46:15 +02:00
nfpm/www/docs/usage.md
Carlos A Becker 5b082c88bc
docs: udpate
Signed-off-by: Carlos A Becker <caarlos0@users.noreply.github.com>
2023-01-02 22:26:17 -03:00

28 lines
707 B
Markdown

# Usage
nFPM can be used both as command line tool or as a library.
## Command Line
To create a sample configuration file, run:
```sh
nfpm init
```
You can then customize it and package to the formats you want:
```sh
nfpm pkg --packager deb --target /tmp/
nfpm pkg --packager rpm --target /tmp/
```
You can learn about it in more detail in the
[command line reference section](/cmd/nfpm/).
## Go Library
Check out the [GoDocs page](https://pkg.go.dev/github.com/goreleaser/nfpm/v2?tab=doc),
the [nFPM command line implementation](https://github.com/goreleaser/nfpm/blob/main/cmd/nfpm/main.go)
and [GoReleaser's usage](https://github.com/goreleaser/goreleaser/blob/main/internal/pipe/nfpm/nfpm.go).