Skip to main content

Help Center

This category lists the 3 Runtime system commands under system.help..

1. List helps​

Full name: system.help.list

List released Soln Help Center topics with their docId, title, group, url, and section titles. Use it to browse the product manual before answering a how-to question. · Risk: Read

sl system help list \
  [--keyword value] [--locale en|zh-CN] [--limit n] [--json]

Parameters:

  • keyword（optional）— Optional filter over help topic titles, paths, and section titles
  • locale（optional）— Help content locale: en or zh-CN. Defaults to the conversation locale, then en
  • limit（optional）— Number of topics, 1-200; defaults to 50

2. Search help​

Full name: system.help.search

Search the released Soln Help Center content for the steps that answer a how-to question about using Soln, returning matching topics with a bounded snippet and the page url to cite. · Risk: Read

sl system help search \
  --query value [--locale en|zh-CN] [--limit n] [--json]

Parameters:

  • query（required）— Natural-language description of the system task the user wants to perform, in the user language
  • locale（optional）— Help content locale: en or zh-CN. Defaults to the conversation locale, then en
  • limit（optional）— Number of matching topics, 1-20; defaults to 5

3. Read help​

Full name: system.help.read

Read one released Help Center topic by docId with bounded character pagination. Use the docId returned by system.help.search or system.help.list. · Risk: Read

sl system help read \
  --doc-id value [--locale en|zh-CN] [--start-character n] \
  [--max-chars n] [--json]

Parameters:

  • docId（required）— Topic docId returned by system.help.search or system.help.list, for example using-soln/forms/using-forms
  • locale（optional）— Help content locale: en or zh-CN. Defaults to the conversation locale, then en. English is used when the topic has no translation
  • startCharacter（optional）— Character offset for continued reading; use position.next from the previous response
  • maxChars（optional）— Maximum characters returned in one call, 500-40000; defaults to 8000