Skip to content

Commit f6341ef

Browse files
author
Josh Newman
committed
update documentation
1 parent c63bacb commit f6341ef

File tree

1 file changed

+99
-2
lines changed

1 file changed

+99
-2
lines changed

README.md

Lines changed: 99 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,13 @@ Available Commands:
4040
ls List parameters by path
4141
migrate Migrate parameters by path
4242
put Put parameter by path
43-
rm Remove parameter by path
43+
rm Remove parameter(s) by path
4444

4545
Flags:
4646
--config string config file (default is $HOME/.ezparams.yaml)
4747
-h, --help help for ezparams
48+
-l, --local-time convert UTC to local time (default true)
4849
--region string AWS Region to use
49-
-l, --useLocalTime convert UTC to local time (default true)
5050
--version Show version
5151

5252
Use "ezparams [command] --help" for more information about a command.
@@ -56,3 +56,100 @@ Use "ezparams [command] --help" for more information about a command.
5656

5757
Right now it uses your default profile found in ~/.aws/credentials. You can change the region to use
5858
on any command but for now it pulls from your [default] defined.
59+
60+
## Commands
61+
62+
### `ls`
63+
64+
Lists parameters in specified path.
65+
66+
```console
67+
$ ezparams ls --help
68+
List parameters by path
69+
70+
Usage:
71+
ezparams ls <path> [flags]
72+
73+
Flags:
74+
-d, --decrypt decrypt "SecureString" values (default true)
75+
-h, --help help for ls
76+
-p, --plain plain text instead of table
77+
-r, --recursive recursively get values based on path (default true)
78+
-v, --values display values
79+
80+
Global Flags:
81+
--config string config file (default is $HOME/.ezparams.yaml)
82+
-l, --local-time convert UTC to local time (default true)
83+
--region string AWS region to use
84+
--version show version
85+
```
86+
87+
### `put`
88+
89+
Put a parameter to the specified path.
90+
91+
```console
92+
$ ezparams put --help
93+
Put parameter by path
94+
95+
Usage:
96+
ezparams put <path> <value> [flags]
97+
98+
Flags:
99+
-h, --help help for put
100+
-o, --overwrite Overwrite param if exists.
101+
-t, --type string Type of parameter. (default "SecureString")
102+
103+
Global Flags:
104+
--config string config file (default is $HOME/.ezparams.yaml)
105+
-l, --local-time convert UTC to local time (default true)
106+
--region string AWS region to use
107+
--version show version
108+
```
109+
110+
### `rm`
111+
112+
Remove a parameter by path. You can also remove recursively by path with the --recursive flag.
113+
114+
```console
115+
$ ezparams rm --help
116+
Remove parameter(s) by path
117+
118+
Usage:
119+
ezparams rm <path> [flags]
120+
121+
Flags:
122+
-h, --help help for rm
123+
--recursive remove all children on path recursively
124+
125+
Global Flags:
126+
--config string config file (default is $HOME/.ezparams.yaml)
127+
-l, --local-time convert UTC to local time (default true)
128+
--region string AWS region to use
129+
--version show version
130+
```
131+
132+
### `migrate`
133+
134+
Migrate parameters from one path to another. Supports region to region. _This command will use the
135+
same region if `region-to` is not specified._
136+
137+
```console
138+
$ ezparams migrate --help
139+
Migrate parameters by path
140+
141+
Usage:
142+
ezparams migrate <source path> [destination path] [flags]
143+
144+
Flags:
145+
-h, --help help for migrate
146+
--overwrite overwrite destination params
147+
-f, --region-from string the region to migrate from
148+
-t, --region-to string the region to migrate to
149+
150+
Global Flags:
151+
--config string config file (default is $HOME/.ezparams.yaml)
152+
-l, --local-time convert UTC to local time (default true)
153+
--region string AWS region to use
154+
--version show version
155+
```

0 commit comments

Comments
 (0)