codelinksUsage: codelinks [OPTIONS] COMMAND [ARGS]...╭─ Options ─────────────────────────────────────────────────────────────────────────╮│--install-completionInstall completion for the current shell.││--show-completionShow completion for the current shell, to copy it ││or customize the installation. ││--helpShow this message and exit.│╰───────────────────────────────────────────────────────────────────────────────────╯╭─ Commands ────────────────────────────────────────────────────────────────────────╮│analyse Analyse marked content in source code. ││discoverDiscover the filepaths from the given root directory. │╰───────────────────────────────────────────────────────────────────────────────────╯╭─ Sub-menus ───────────────────────────────────────────────────────────────────────╮│write Export marked content to other formats │╰───────────────────────────────────────────────────────────────────────────────────╯
codelinksUsage: codelinks [OPTIONS] COMMAND [ARGS]...╭─ Options ─────────────────────────────────────────────────────────────────────────╮│--install-completionInstall completion for the current shell.││--show-completionShow completion for the current shell, to copy it ││or customize the installation. ││--helpShow this message and exit.│╰───────────────────────────────────────────────────────────────────────────────────╯╭─ Commands ────────────────────────────────────────────────────────────────────────╮│analyse Analyse marked content in source code. ││discoverDiscover the filepaths from the given root directory. │╰───────────────────────────────────────────────────────────────────────────────────╯╭─ Sub-menus ───────────────────────────────────────────────────────────────────────╮│write Export marked content to other formats │╰───────────────────────────────────────────────────────────────────────────────────╯
analyseUsage: codelinks analyse [OPTIONS] {config}Analyse marked content in source code.╭─ Arguments ───────────────────────────────────────────────────────────────────────╮│*config<file>The toml config file[required]│╰───────────────────────────────────────────────────────────────────────────────────╯╭─ Options ─────────────────────────────────────────────────────────────────────────╮│--project-p<str>Specify the project name of the config. If not ││specified, take all ││--outdir-o<directory>The output directory. When given, this overwrites││the config's outdir ││--helpShow this message and exit.│╰───────────────────────────────────────────────────────────────────────────────────╯╭─ Logging ─────────────────────────────────────────────────────────────────────────╮│--verbose-vShow debug information││--quiet-qOnly show errors and warnings│╰───────────────────────────────────────────────────────────────────────────────────╯
analyseUsage: codelinks analyse [OPTIONS] {config}Analyse marked content in source code.╭─ Arguments ───────────────────────────────────────────────────────────────────────╮│*config<file>The toml config file[required]│╰───────────────────────────────────────────────────────────────────────────────────╯╭─ Options ─────────────────────────────────────────────────────────────────────────╮│--project-p<str>Specify the project name of the config. If not ││specified, take all ││--outdir-o<directory>The output directory. When given, this overwrites││the config's outdir ││--helpShow this message and exit.│╰───────────────────────────────────────────────────────────────────────────────────╯╭─ Logging ─────────────────────────────────────────────────────────────────────────╮│--verbose-vShow debug information││--quiet-qOnly show errors and warnings│╰───────────────────────────────────────────────────────────────────────────────────╯
discoverUsage: codelinks discover [OPTIONS] {src_dir}Discover the filepaths from the given root directory.╭─ Arguments ───────────────────────────────────────────────────────────────────────╮│*src_dir<directory>Root directory for discovery[required]│╰───────────────────────────────────────────────────────────────────────────────────╯╭─ Options ─────────────────────────────────────────────────────────────────────────╮│--excludes-e<str>Glob patterns to be││excluded. ││--includes-i<str>Glob patterns to be││included. ││--gitignore--no-gitignoreRespect .gitignore ││files in the given ││directory and its ││parents ││[default: ││gitignore] ││--follow-links--no-follow-linksFollow symbolic ││links during file ││discovery ││[default: ││no-follow-links] ││--comment-type-c<python|cpp|cs|yamlThe relevant file ││|rust|go|jsonc|bashextensions which ││>use the specified ││the comment type ││will be discovered.││[default: cpp] ││--helpShow this message ││and exit. │╰───────────────────────────────────────────────────────────────────────────────────╯
discoverUsage: codelinks discover [OPTIONS] {src_dir}Discover the filepaths from the given root directory.╭─ Arguments ───────────────────────────────────────────────────────────────────────╮│*src_dir<directory>Root directory for discovery[required]│╰───────────────────────────────────────────────────────────────────────────────────╯╭─ Options ─────────────────────────────────────────────────────────────────────────╮│--excludes-e<str>Glob patterns to be││excluded. ││--includes-i<str>Glob patterns to be││included. ││--gitignore--no-gitignoreRespect .gitignore ││files in the given ││directory and its ││parents ││[default: ││gitignore] ││--follow-links--no-follow-linksFollow symbolic ││links during file ││discovery ││[default: ││no-follow-links] ││--comment-type-c<python|cpp|cs|yamlThe relevant file ││|rust|go|jsonc|bashextensions which ││>use the specified ││the comment type ││will be discovered.││[default: cpp] ││--helpShow this message ││and exit. │╰───────────────────────────────────────────────────────────────────────────────────╯
writeUsage: codelinks write [OPTIONS] COMMAND [ARGS]...Export marked content to other formats╭─ Options ─────────────────────────────────────────────────────────────────────────╮│--helpShow this message and exit.│╰───────────────────────────────────────────────────────────────────────────────────╯╭─ Commands ────────────────────────────────────────────────────────────────────────╮│rstGenerate needextend.rst from the extracted obj in JSON. │╰───────────────────────────────────────────────────────────────────────────────────╯
writeUsage: codelinks write [OPTIONS] COMMAND [ARGS]...Export marked content to other formats╭─ Options ─────────────────────────────────────────────────────────────────────────╮│--helpShow this message and exit.│╰───────────────────────────────────────────────────────────────────────────────────╯╭─ Commands ────────────────────────────────────────────────────────────────────────╮│rstGenerate needextend.rst from the extracted obj in JSON. │╰───────────────────────────────────────────────────────────────────────────────────╯
rstUsage: codelinks write rst [OPTIONS] {jsonpath}Generate needextend.rst from the extracted obj in JSON.╭─ Arguments ───────────────────────────────────────────────────────────────────────╮│*jsonpath<file>Path of the JSON file which contains the extracted ││markers ││[required] │╰───────────────────────────────────────────────────────────────────────────────────╯╭─ Options ─────────────────────────────────────────────────────────────────────────╮│--outpath-o<file>The output path for generated rst file││[default: needextend.rst] ││--remote-url-field-r<str>The field name for the remote url││[default: remote_url] ││--title-t<str>Give the title to the generated RST file││--helpShow this message and exit.│╰───────────────────────────────────────────────────────────────────────────────────╯╭─ Logging ─────────────────────────────────────────────────────────────────────────╮│--verbose-vShow debug information││--quiet-qOnly show errors and warnings│╰───────────────────────────────────────────────────────────────────────────────────╯
rstUsage: codelinks write rst [OPTIONS] {jsonpath}Generate needextend.rst from the extracted obj in JSON.╭─ Arguments ───────────────────────────────────────────────────────────────────────╮│*jsonpath<file>Path of the JSON file which contains the extracted ││markers ││[required] │╰───────────────────────────────────────────────────────────────────────────────────╯╭─ Options ─────────────────────────────────────────────────────────────────────────╮│--outpath-o<file>The output path for generated rst file││[default: needextend.rst] ││--remote-url-field-r<str>The field name for the remote url││[default: remote_url] ││--title-t<str>Give the title to the generated RST file││--helpShow this message and exit.│╰───────────────────────────────────────────────────────────────────────────────────╯╭─ Logging ─────────────────────────────────────────────────────────────────────────╮│--verbose-vShow debug information││--quiet-qOnly show errors and warnings│╰───────────────────────────────────────────────────────────────────────────────────╯