- Function Overview
- What's New
- Service Overview
- Getting Started
-
User Guide
- Configuration Management
- HTTP Proxy
- Commonly Used Commands
-
Options
- Option Overview
- Printing Help Information
- Printing Debugging Information
- Checking Command
- Specifying Region
- Calling APIs with an Account in Non-configuration Mode
- Calling APIs with AK/SK in Non-configuration Mode
- Calling APIs with a Token in Non-configuration Mode
- Calling APIs Using an Agency in Non-configuration Mode
- Specifying Account ID
- Specifying Profile
- Specifying Authentication Mode
- Specifying Output Format
- Passing API Parameters with JSON File
- Specifying Request Timeouts
- Specifying Retry Count
- Skipping HTTPS Request Certificate Verification
- Specifying a Domain Name
- Obtaining CLI Examples on API Explorer
- Using KooCLI in Non-configuration Mode
- Obtaining Authentication Information
-
FAQs
- Overview
- Authentication
- Profiles
- Metadata Cache
- Logs
- Network Connections
- Cloud Services
- Cloud Service APIs
- Regions
-
Parameters
- What Are KooCLI System Parameters?
- Why Am I Seeing a Message Indicating an Invalid Parameter?
- Why Are Old and New KooCLI System Parameters (Such as region and cli-region) Available? Which Parameters Are Recommended?
- Why Am I Seeing a Message Indicating a Duplicate Parameter?
- How Do I Use cli-jsonInput?
- When Can I Use cli-jsonInput?
- Why Am I Seeing a Message Indicating an Unsupported Parameter Position or Type?
- How Do I Leave a Body Parameter Empty for Cloud Service APIs?
- Interactive Mode and Autocomplete
-
Output Formats
- What Output Formats Are Supported by KooCLI?
- How Do I Define a JMESPath Expression?
- Which KooCLI System Parameters Are Related to Data Output? Which Ones Are Recommended?
- How Do I Use cli-output, cli-query, and cli-output-num?
- How Do I Use cli-output-rows, cli-output-cols, and cli-output-num? What Are the Precautions?
- How Do I Use cli-json-filter? What Are the Precautions?
- Other
- Videos
Show all
What Are the Application Scenarios of Online/Offline Modes?
- Viewing/Switching the current mode
KooCLI can stay in online/offline modes. By default, it is offline. After configuring a profile, you can run hcloud configure list --cli-query=offline to check whether the offline mode is used.
- To switch to offline mode, run the hcloud configure set --cli-offline=true command.
- To switch to online mode, run the hcloud configure set --cli-offline=false command.
- Offline mode scenario
Download the latest offline metadata of KooCLI to a local directory. The metadata cache files have unlimited validity. When you run KooCLI commands, the file content will be read for command verification and parsing. In this mode, local metadata cache files will not be automatically updated, and parameter verification for existing commands will not be affected. This ensures that the built KooCLI commands are always available. Use this mode if you build scripts with KooCLI commands and periodically execute the scripts to manage cloud services and resources.
- Online mode scenario
KooCLI obtains metadata and caches it locally during command execution. The metadata cache files have limited validity. If a file has expired, KooCLI updates it and then uses it for command verification and parsing. In this mode, only the metadata related to your executed commands is saved, and you can call APIs of new cloud services through KooCLI. Use this mode if you need to run any KooCLI commands immediately to manage cloud services and resources.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
