Document Search

v3.0.0+

The tcb docs command has been available since v3.0.0 and can be used without logging in.

The tcb docs command is used to directly search and read CloudBase official documentation within the terminal without the need to open a browser.

List all documentation modules

List all top-level business modules in the CloudBase documentation site:

tcb docs list

Example Output:

Documentation Site Business Module List:
  01  SCF
  02  Database
  03  Cloud storage
  04  Cloud Run
  05  MySQL Database
  ...

Read Document Content

Retrieve detailed content of specified modules or documents. Supports multiple input methods:

# Read Module Document Directory
tcb docs read <module name>

# Reading by Hierarchical Path (a.b.c format)
tcb docs read MySQLDatabase.DataOperations.FieldTypes

# Search by Document Title
tcb docs read SCF deployment

# Read Document URL Directly
tcb docs read https://docs.cloudbase.net/cli-v1/functions/deploy

Example:

# List modules first
tcb docs list

# Read SCF Module Document Directory
tcb docs read SCF

# Read Specific Documents by Path
tcb docs read SCF.deployment.quickstart

Keyword-based Document Search

Searching documents by keywords, returning a list of relevant documents:

tcb docs search <keywords>

Example:

# Searching SCF-related Documents
tcb docs search SCF deployment

# Searching MySQL-related Documents
tcb docs search MySQL backup

Example Output:

Search results (3 items):

  01  Deploy SCF
      https://docs.cloudbase.net/cli-v1/functions/deploy
      Using the tcb fn deploy command can quickly deploy SCF to the TCB environment...

  02  Function Configuration
      https://docs.cloudbase.net/cli-v1/functions/configs
      Descriptions of SCF configuration items in cloudbaserc.json...

Typical Workflow

# 1. Don't know which modules are available? List all first
tcb docs list

# 2. Select the module you are interested in and view its document directory
tcb docs read database

# 3. Find the specific document and then read its content.
tcb docs read database.data model management

# 4. Unsure about the path? Search by keyword
tcb docs search data model pull

Command Quick Reference

Command	Description
tcb docs list	List all top-level document modules
tcb docs read <path\|title\|URL>	Read document content
tcb docs search <keywords>	Search documents by keywords