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. ││discover Discover the filepaths from the given root directory. │╰───────────────────────────────────────────────────────────────────────────────────╯╭─ Sub-menus ───────────────────────────────────────────────────────────────────────╮│write Export marked content to other formats │╰───────────────────────────────────────────────────────────────────────────────────╯
analyseUsage: codelinks analyse [OPTIONS] CONFIGAnalyse marked content in source code.╭─ Arguments ───────────────────────────────────────────────────────────────────────╮│*configFILEThe toml config file[required]│╰───────────────────────────────────────────────────────────────────────────────────╯╭─ Options ─────────────────────────────────────────────────────────────────────────╮│--project-pTEXT Specify the project name of the config. If not ││specified, take all ││[default: None] ││--outdir-oDIRECTORYThe output directory. When given, this overwrites ││the config's outdir ││[default: None] ││--helpShow this message and exit.│╰───────────────────────────────────────────────────────────────────────────────────╯
discoverUsage: codelinks discover [OPTIONS] SRC_DIRDiscover the filepaths from the given root directory.╭─ Arguments ───────────────────────────────────────────────────────────────────────╮│*src_dirDIRECTORYRoot directory for discovery[required]│╰───────────────────────────────────────────────────────────────────────────────────╯╭─ Options ─────────────────────────────────────────────────────────────────────────╮│--excludes-eTEXT Glob patterns to be excluded.││--includes-iTEXT Glob patterns to be included.││--gitignore--no-gitignoreRespect .gitignore in the ││given directory. Nested ││.gitignore Not supported ││[default: gitignore] ││--comment-type-c[python|cpp]The relevant file extensions ││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 ────────────────────────────────────────────────────────────────────────╮│rst Generate needextend.rst from the extracted obj in JSON. │╰───────────────────────────────────────────────────────────────────────────────────╯
rstUsage: codelinks write rst [OPTIONS] JSONPATHGenerate needextend.rst from the extracted obj in JSON.╭─ Arguments ───────────────────────────────────────────────────────────────────────╮│*jsonpathFILEPath of the JSON file which contains the extracted ││markers ││[required] │╰───────────────────────────────────────────────────────────────────────────────────╯╭─ Options ─────────────────────────────────────────────────────────────────────────╮│--outpath-oFILEThe output path for generated rst file││[default: needextend.rst] ││--remote-url-field-rTEXTThe field name for the remote url││[default: remote_url] ││--title-tTEXTGive the title to the generated RST file││[default: None] ││--helpShow this message and exit.│╰───────────────────────────────────────────────────────────────────────────────────╯╭─ Logging ─────────────────────────────────────────────────────────────────────────╮│--verbose-vShow debug information││--quiet-qOnly show errors and warnings│╰───────────────────────────────────────────────────────────────────────────────────╯