Skip to content

Commit 36a8ab1

Browse files
committed
docs(readme): add docs workspace, state and output commands
1 parent 029e39e commit 36a8ab1

File tree

1 file changed

+40
-10
lines changed

1 file changed

+40
-10
lines changed

README.md

+40-10
Original file line numberDiff line numberDiff line change
@@ -22,20 +22,50 @@ Terraform cloud scripts
2222
### Usage:
2323

2424
```shell
25-
terraform-cloud <resource> <action> [arguments]
25+
terraform-cloud <command> <sucommand> [arguments]
2626
```
2727
OR
2828
```shell
29-
tfc <resource> <action> [arguments]
29+
tfc <command> <sucommand> [arguments]
3030
```
31-
### Available Allowed Resources:
31+
### Available Commands and Subcommands:
3232
- `workspace`
33+
- `get` - Prints the provided workspace as output
34+
35+
Example:
36+
```shell
37+
$ tfc workspace get orgnization/workspace
38+
```
39+
- `list` - List all workspaces in Organization.
40+
41+
Note: In case of missing organization name, Throws an error and outputs all available organizations in the account.
42+
43+
Example:
44+
```shell
45+
$ tfc workspace list
46+
47+
Error: Organization Missing
48+
Please pass organization from list below:
49+
- OrgA
50+
- OrgB
51+
52+
53+
Terraform Cloud - Devops Scripts
54+
55+
Github: https://github.com/phenixcoder/devops-scripts
56+
57+
Usage:
58+
terraform-cloud <resource> <action> [arguments]
59+
OR
60+
tfc <resource> <action> [arguments]
61+
62+
```
63+
OR
64+
```shell
65+
$ tfc workspace list orgnization
66+
```
3367
- `output`
68+
- `get` - Get the first output from latest state and prints as output
69+
- `list` - Lista all output in the state.
3470
- `state`
35-
36-
### Available Allowed Actions:
37-
- `get`
38-
- `set`
39-
- `list`
40-
41-
---
71+
- `get` - Get the latest state and prints as output

0 commit comments

Comments
 (0)