Skip to content

feat: add JSON output format to many CLI commands #6082

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Feb 8, 2023
Merged

feat: add JSON output format to many CLI commands #6082

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
457cd51
chore: make output formatting generic
deansheather Feb 7, 2023
e33bde8
feat: add JSON output format to many CLI commands
deansheather Feb 7, 2023
1ad2a4c
fixup! feat: add JSON output format to many CLI commands
deansheather Feb 7, 2023
1ced0ce
chore: add more output format tests
deansheather Feb 7, 2023
54b0a94
fixup! chore: add more output format tests
deansheather Feb 8, 2023
3eb6813
chore: add golden files for json commands
deansheather Feb 8, 2023
92a125e
Merge branch 'main' into dean/output-formats
deansheather Feb 8, 2023
ec4a432
fixup! Merge branch 'main' into dean/output-formats
deansheather Feb 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
fixup! Merge branch 'main' into dean/output-formats
  • Loading branch information
@deansheather
deansheather committed Feb 8, 2023
commit ec4a432a43e0063b85a39919393891a62b96a3a9
9 changes: 5 additions & 4 deletions docs/cli/coder_list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,11 @@ coder list [flags]
### Options

```
-a, --all Specifies whether all workspaces will be listed or not.
-c, --column stringArray Specify a column to filter in the table. Available columns are: workspace, template, status, last_built, outdated, starts_at, stops_after
-h, --help help for list
--search string Search for a workspace with a query. (default "owner:me")
-a, --all Specifies whether all workspaces will be listed or not.
-c, --column strings Columns to display in table output. Available columns: workspace, template, status, last built, outdated, starts at, stops after (default [workspace,template,status,last built,outdated,starts at,stops after])
-h, --help help for list
-o, --output string Output format. Available formats: table, json (default "table")
--search string Search for a workspace with a query. (default "owner:me")
```

### Options inherited from parent commands
Expand Down
5 changes: 3 additions & 2 deletions docs/cli/coder_templates_list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@ coder templates list [flags]
### Options

```
-c, --column stringArray Specify a column to filter in the table. (default [name,last_updated,used_by])
-h, --help help for list
-c, --column strings Columns to display in table output. Available columns: name, created at, last updated, organization id, provisioner, active version id, used by, default ttl (default [name,last updated,used by])
-h, --help help for list
-o, --output string Output format. Available formats: table, json (default "table")
```

### Options inherited from parent commands
Expand Down
4 changes: 3 additions & 1 deletion docs/cli/coder_templates_versions_list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ coder templates versions list <template> [flags]
### Options

```
-h, --help help for list
-c, --column strings Columns to display in table output. Available columns: name, created at, created by, status, active (default [name,created at,created by,status,active])
-h, --help help for list
-o, --output string Output format. Available formats: table, json (default "table")
```

### Options inherited from parent commands
Expand Down
4 changes: 3 additions & 1 deletion docs/cli/coder_tokens_list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ coder tokens list [flags]
### Options

```
-h, --help help for list
-c, --column strings Columns to display in table output. Available columns: id, last used, expires at, created at (default [id,last used,expires at,created at])
-h, --help help for list
-o, --output string Output format. Available formats: table, json (default "table")
```

### Options inherited from parent commands
Expand Down
6 changes: 3 additions & 3 deletions docs/cli/coder_users_list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ coder users list [flags]
### Options

```
-c, --column stringArray Specify a column to filter in the table. Available columns are: id, username, email, created_at, status. (default [username,email,created_at,status])
-h, --help help for list
-o, --output string Output format. Available formats are: table, json. (default "table")
-c, --column strings Columns to display in table output. Available columns: id, username, email, created at, status (default [username,email,created_at,status])
-h, --help help for list
-o, --output string Output format. Available formats: table, json (default "table")
```

### Options inherited from parent commands
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/coder_users_show.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ coder users show <username|user_id|'me'> [flags]

```
-h, --help help for show
-o, --output string Output format. Available formats are: table, json. (default "table")
-o, --output string Output format. Available formats: table, json (default "table")
```

### Options inherited from parent commands
Expand Down