English

简体中文

English

简体中文

Export Tool summary ​

Purpose ​

Read the Markdown summary for NAME:VERSION, optionally selecting a heading path.

Syntax ​

bash
fkit tool summary export [OPTIONS] <TOOL_VERSION_NAME>

Arguments and options ​

  • --output <PATH> — Optional; write to a new file and refuse to overwrite.
  • --json — Emit JSON containing version IDs, summary, and section.
  • --section <HEADING/PATH> — Select the exact heading path and its descendant content.

Effect ​

Reads platform or project data and does not submit remote changes.

Safe use ​

Markdown goes to stdout by default. --output writes a new file and refuses to overwrite. --section selects an exact, case-sensitive ATX heading path; missing or duplicate paths are errors.

Output ​

With --json, output is {toolId, toolVersionId, name, version, summary, section}. When combined with --output, JSON is written to the file and status goes to stderr.

Read this page ​

Add --docs to read this page from the official BioLine AI documentation service before business arguments are required, sign-in is checked, or the command runs. Choose language with --docs-lang zh|en and use --docs-json for the documentation JSON wrapper. The index and Markdown are fetched from the same official AI service; the index is fixed at https://www.bioline.cloud/ai/commandLineAndFkit/.

bash
fkit tool summary export --docs --docs-json --docs-lang en