https://github.com/withfig/fig_kingpin
Generate Fig Spec from Go Kingpin
https://github.com/withfig/fig_kingpin
Last synced: about 1 year ago
JSON representation
Generate Fig Spec from Go Kingpin
- Host: GitHub
- URL: https://github.com/withfig/fig_kingpin
- Owner: withfig
- License: mit
- Created: 2023-06-13T18:11:39.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-15T21:32:51.000Z (about 3 years ago)
- Last Synced: 2025-03-26T06:11:37.196Z (over 1 year ago)
- Language: Go
- Homepage:
- Size: 10.7 KB
- Stars: 2
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Fig Kingpin
Support for generating Fig Spec from [Kingpin CLI apps](https://github.com/alecthomas/kingpin)
## Usage
### 1. Add the `figkingpin` package and `--completion-spec-fig` to your app
```go
import (
"github.com/alecthomas/kingpin/v2"
// 1. Add the figkingpin package
figkingpin "github.com/withfig/fig_kingpin"
)
var (
app = kingpin.New("App", "A demo app")
// 2. Add a top level flag to gen fig spec, it is hidden from the help output
completionSpecFig = app.Flag("completion-spec-fig", "Generate completion script for fig.").Hidden().PreAction(figkingpin.GenerateFigCompletionSpec(app)).Bool()
)
```
### 2. Generate a Fig Spec via `--completion-spec-fig`
```bash
go run main.go --completion-spec-fig > fig-spec.ts
```