On this page

Show all

Help Center/ Koo Command Line Interface/ FAQs/ Output Formats/ How Do I Use cli-output, cli-query, and cli-output-num?

How Do I Use cli-output, cli-query, and cli-output-num?

Updated on 2023-02-27 GMT+08:00

View PDF

For details about how to use the new output parameters, see Specifying Output Format.

In a command, use --cli-query to pass a JMESPath expression and perform a JMESPath query on the result to extract key information in the original returned result. Use --cli-output to specify the response data output format. Use --cli-output-num to specify whether to print the row numbers during table output.

When you use the preceding parameters, note that:

Use only --cli-output in a command to specify the output format. If you use only --cli-query in a command, the default output format is JSON.
When using --cli-query, enclose the value with double quotation marks ("") to avoid parsing errors when the system processes commands.
When using --cli-output-num to specify whether to print the row numbers, set --cli-output to table.
In the same command, if --cli-output has been used and old system parameters such as --cli-output-rows and --cli-json-filter are specified, the value of --cli-output is preferentially used as the target output format.

Parent topic: Output Formats

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel