Skip to content

Commit 9a5f50d

Browse files
author
ethanluo
committed
update readme
1 parent 308ad1c commit 9a5f50d

File tree

3 files changed

+42
-4
lines changed

3 files changed

+42
-4
lines changed

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,41 @@
11
# helmtrans
22
yaml to helm
3+
4+
## Usage:
5+
6+
### Yaml to Helm
7+
8+
help:
9+
10+
```sh
11+
➜ helmtrans -h
12+
13+
helmtrans is a CLI library for Go that support yaml to helm.
14+
15+
Usage:
16+
helmtrans [command]
17+
18+
Available Commands:
19+
help Help about any command
20+
version Print the version number of helmtrans
21+
yamltohelm Transform yaml to helm
22+
23+
Flags:
24+
-h, --help help for helmtrans
25+
```
26+
27+
yaml to helm
28+
29+
```sh
30+
helmtrans yamltohelm -p [source path] -o [output path]
31+
```
32+
-o is optional param (default is output)
33+
34+
35+
### Helm to Yaml
36+
37+
you can use **schelm**[https://github.com/databus23/schelm] to render a helm manifest to a directory.
38+
39+
## Maintainer
40+
41+

cmd/helmtrans_cmd.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ func init() {
1515
rootCmd.AddCommand(helmtransYamltoHelmCmd)
1616

1717
helmtransHelmtoYamlCmd.Flags().StringVarP(&filePath, "path", "p", "", "file path")
18-
rootCmd.AddCommand(helmtransHelmtoYamlCmd)
18+
// rootCmd.AddCommand(helmtransHelmtoYamlCmd)
1919

2020
helmtransCheckCmd.Flags().StringVarP(&filePath, "path", "p", "", "file path")
21-
rootCmd.AddCommand(helmtransCheckCmd)
21+
// rootCmd.AddCommand(helmtransCheckCmd)
2222
}
2323

2424
//register deploy command

cmd/root.go

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@ var rootCmd = &cobra.Command{
2828
Use: "helmtrans [command] [options]",
2929
Short: "helmtrans can transform yaml to helm and the other way around",
3030
Long: `
31-
helmtrans is a CLI library for Go that support yaml to helm,
32-
also helm to yaml. You can use it as http request to transform.`,
31+
helmtrans is a CLI library for Go that support yaml to helm.`,
3332
// Uncomment the following line if your bare application
3433
// has an action associated with it:
3534
// Run: func(cmd *cobra.Command, args []string) { },

0 commit comments

Comments
 (0)