From 4342eaf532984875dba8496ee104402d4d3e166b Mon Sep 17 00:00:00 2001 From: Carlos Scheidegger Date: Wed, 30 Apr 2025 15:44:08 -0400 Subject: [PATCH 01/18] add quarto cli-info output --- docs/cli/cli-info.json | 5382 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 5382 insertions(+) create mode 100644 docs/cli/cli-info.json diff --git a/docs/cli/cli-info.json b/docs/cli/cli-info.json new file mode 100644 index 0000000000..5771d0026f --- /dev/null +++ b/docs/cli/cli-info.json @@ -0,0 +1,5382 @@ +{ + "version": "99.9.9", + "commands": [ + { + "name": "render", + "description": "Render files or projects to various document types.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + }, + { + "name": "to", + "description": "Specify output format(s).", + "args": [], + "flags": [ + "-t", + "--to" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "t" + ] + }, + { + "name": "output", + "description": "Write output to FILE (use '--output -' for stdout).", + "args": [], + "flags": [ + "-o", + "--output" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "o" + ] + }, + { + "name": "output-dir", + "description": "Write output to DIR (path is input/project relative)", + "args": [], + "flags": [ + "--output-dir" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "name": "metadata", + "description": "Metadata value (KEY:VALUE).", + "args": [], + "flags": [ + "-M", + "--metadata" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "M" + ] + }, + { + "name": "site-url", + "description": "Override site-url for website or book output", + "args": [], + "flags": [ + "--site-url" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "name": "execute", + "description": "Execute code (--no-execute to skip execution).", + "args": [], + "flags": [ + "--execute" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "name": "execute-param", + "description": "Execution parameter (KEY:VALUE).", + "args": [], + "flags": [ + "-P", + "--execute-param" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "P" + ] + }, + { + "name": "execute-params", + "description": "YAML file with execution parameters.", + "args": [], + "flags": [ + "--execute-params" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "name": "execute-dir", + "description": "Working directory for code execution.", + "args": [], + "flags": [ + "--execute-dir" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "name": "execute-daemon", + "description": "Keep Jupyter kernel alive (defaults to 300 seconds).", + "args": [], + "flags": [ + "--execute-daemon" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "name": "execute-daemon-restart", + "description": "Restart keepalive Jupyter kernel before render.", + "args": [], + "flags": [ + "--execute-daemon-restart" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "name": "execute-debug", + "description": "Show debug output when executing computations.", + "args": [], + "flags": [ + "--execute-debug" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "name": "use-freezer", + "description": "Force use of frozen computations for an incremental file render.", + "args": [], + "flags": [ + "--use-freezer" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "name": "cache", + "description": "Cache execution output (--no-cache to prevent cache).", + "args": [], + "flags": [ + "--cache" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "name": "cache-refresh", + "description": "Force refresh of execution cache.", + "args": [], + "flags": [ + "--cache-refresh" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "name": "no-clean", + "description": "Do not clean project output-dir prior to render", + "args": [], + "flags": [ + "--no-clean" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "name": "debug", + "description": "Leave intermediate files in place after render.", + "args": [], + "flags": [ + "--debug" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "name": "", + "description": "Additional pandoc command line arguments.", + "args": [], + "flags": [ + "pandoc-args..." + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "andoc-args..." + ] + }, + { + "global": true, + "name": "log", + "description": "Path to log file", + "args": [ + { + "optional": false, + "name": "file", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-level", + "description": "Log level (info, warning, error, critical)", + "args": [ + { + "optional": false, + "name": "level", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-level" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-format", + "description": "Log format (plain, json-stream)", + "args": [ + { + "optional": false, + "name": "format", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-format" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "quiet", + "description": "Suppress console output.", + "args": [], + "flags": [ + "--quiet" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "profile", + "description": "Active project profile(s)", + "args": [], + "flags": [ + "--profile" + ], + "equalsSign": false, + "typeDefinition": "" + } + ], + "usage": "[input:string] [...args]", + "examples": [ + { + "name": "Render Markdown", + "description": "quarto render document.qmd\nquarto render document.qmd --to html\nquarto render document.qmd --to pdf --toc" + }, + { + "name": "Render Notebook", + "description": "quarto render notebook.ipynb\nquarto render notebook.ipynb --to docx\nquarto render notebook.ipynb --to pdf --toc" + }, + { + "name": "Render Project", + "description": "quarto render\nquarto render projdir" + }, + { + "name": "Render w/ Metadata", + "description": "quarto render document.qmd -M echo:false\nquarto render document.qmd -M code-fold:true" + }, + { + "name": "Render to Stdout", + "description": "quarto render document.qmd --output -" + } + ], + "commands": [ + { + "name": "help", + "description": "Show this help or the help of a sub-command.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "[command:command]", + "examples": [], + "commands": [] + } + ] + }, + { + "name": "preview", + "description": "Render and preview a document or website project.\n\nAutomatically reloads the browser when input files or document resources (e.g. CSS) change.\n\nFor website preview, the most recent execution results of computational documents are used to render\nthe site (this is to optimize startup time). If you want to perform a full render prior to\npreviewing pass the --render option with \"all\" or a comma-separated list of formats to render.\n\nFor document preview, input file changes will result in a re-render (pass --no-watch to prevent).\n\nYou can also include arbitrary command line arguments to be forwarded to \u001b[1mquarto render\u001b[22m.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + }, + { + "name": "port", + "description": "Suggested port to listen on (defaults to random value between 3000 and 8000).\nIf the port is not available then a random port between 3000 and 8000 will be selected.", + "args": [ + { + "optional": true, + "name": "port", + "action": "number", + "variadic": false, + "list": false, + "type": "number" + } + ], + "flags": [ + "--port" + ], + "equalsSign": false, + "typeDefinition": "[port:number]" + }, + { + "name": "host", + "description": "Hostname to bind to (defaults to 127.0.0.1)", + "args": [ + { + "optional": true, + "name": "host", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--host" + ], + "equalsSign": false, + "typeDefinition": "[host:string]" + }, + { + "default": "none", + "name": "render", + "description": "Render to the specified format(s) before previewing", + "args": [ + { + "optional": true, + "name": "format", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--render" + ], + "equalsSign": false, + "typeDefinition": "[format:string]" + }, + { + "name": "no-serve", + "description": "Don't run a local preview web server (just monitor and re-render input files)", + "args": [], + "flags": [ + "--no-serve" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "name": "no-navigate", + "description": "Don't navigate the browser automatically when outputs are updated.", + "args": [], + "flags": [ + "--no-navigate" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "name": "no-browser", + "description": "Don't open a browser to preview the site.", + "args": [], + "flags": [ + "--no-browser" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "name": "no-watch-inputs", + "description": "Do not re-render input files when they change.", + "args": [], + "flags": [ + "--no-watch-inputs" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "name": "timeout", + "description": "Time (in seconds) after which to exit if there are no active clients.", + "args": [], + "flags": [ + "--timeout" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log", + "description": "Path to log file", + "args": [ + { + "optional": false, + "name": "file", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-level", + "description": "Log level (info, warning, error, critical)", + "args": [ + { + "optional": false, + "name": "level", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-level" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-format", + "description": "Log format (plain, json-stream)", + "args": [ + { + "optional": false, + "name": "format", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-format" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "quiet", + "description": "Suppress console output.", + "args": [], + "flags": [ + "--quiet" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "profile", + "description": "Active project profile(s)", + "args": [], + "flags": [ + "--profile" + ], + "equalsSign": false, + "typeDefinition": "" + } + ], + "usage": "[file:string] [...args:string]", + "examples": [ + { + "name": "Preview document", + "description": "quarto preview doc.qmd" + }, + { + "name": "Preview document with render command line args", + "description": "quarto preview doc.qmd --toc" + }, + { + "name": "Preview document (don't watch for input changes)", + "description": "quarto preview doc.qmd --no-watch-inputs" + }, + { + "name": "Preview website with most recent execution results", + "description": "quarto preview" + }, + { + "name": "Previewing website using a specific port", + "description": "quarto preview --port 4444" + }, + { + "name": "Preview website (don't open a browser)", + "description": "quarto preview --no-browser" + }, + { + "name": "Fully render all website/book formats then preview", + "description": "quarto preview --render all" + }, + { + "name": "Fully render the html format then preview", + "description": "quarto preview --render html" + } + ], + "commands": [ + { + "name": "help", + "description": "Show this help or the help of a sub-command.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "[command:command]", + "examples": [], + "commands": [] + } + ] + }, + { + "name": "serve", + "description": "Serve a Shiny interactive document.\n\nBy default, the document will be rendered first and then served. If you have previously rendered the document, pass --no-render to skip the rendering step.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + }, + { + "name": "no-render", + "description": "Do not render the document before serving.", + "args": [], + "flags": [ + "--no-render" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "name": "port", + "description": "The TCP port that the application should listen on.", + "args": [ + { + "optional": true, + "name": "port", + "action": "number", + "variadic": false, + "list": false, + "type": "number" + } + ], + "flags": [ + "-p", + "--port" + ], + "equalsSign": false, + "typeDefinition": "[port:number]", + "aliases": [ + "p" + ] + }, + { + "name": "host", + "description": "Hostname to bind to (defaults to 127.0.0.1)", + "args": [ + { + "optional": true, + "name": "host", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--host" + ], + "equalsSign": false, + "typeDefinition": "[host:string]" + }, + { + "name": "browser", + "description": "Open a browser to preview the site.", + "args": [], + "flags": [ + "--browser" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log", + "description": "Path to log file", + "args": [ + { + "optional": false, + "name": "file", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-level", + "description": "Log level (info, warning, error, critical)", + "args": [ + { + "optional": false, + "name": "level", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-level" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-format", + "description": "Log format (plain, json-stream)", + "args": [ + { + "optional": false, + "name": "format", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-format" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "quiet", + "description": "Suppress console output.", + "args": [], + "flags": [ + "--quiet" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "profile", + "description": "Active project profile(s)", + "args": [], + "flags": [ + "--profile" + ], + "equalsSign": false, + "typeDefinition": "" + } + ], + "usage": "[input:string]", + "examples": [ + { + "name": "Serve an interactive Shiny document", + "description": "quarto serve dashboard.qmd" + }, + { + "name": "Serve a document without rendering", + "description": "quarto serve dashboard.qmd --no-render" + } + ], + "commands": [ + { + "name": "help", + "description": "Show this help or the help of a sub-command.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "[command:command]", + "examples": [], + "commands": [] + } + ] + }, + { + "name": "create", + "description": "Create a Quarto project or extension", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + }, + { + "name": "open", + "description": "Open new artifact in this editor (positron, vscode, rstudio)", + "args": [ + { + "optional": true, + "name": "editor", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--open" + ], + "equalsSign": false, + "typeDefinition": "[editor:string]" + }, + { + "name": "no-open", + "description": "Do not open in an editor", + "args": [], + "flags": [ + "--no-open" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "name": "no-prompt", + "description": "Do not prompt to confirm actions", + "args": [], + "flags": [ + "--no-prompt" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log", + "description": "Path to log file", + "args": [ + { + "optional": false, + "name": "file", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-level", + "description": "Log level (info, warning, error, critical)", + "args": [ + { + "optional": false, + "name": "level", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-level" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-format", + "description": "Log format (plain, json-stream)", + "args": [ + { + "optional": false, + "name": "format", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-format" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "quiet", + "description": "Suppress console output.", + "args": [], + "flags": [ + "--quiet" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "profile", + "description": "Active project profile(s)", + "args": [], + "flags": [ + "--profile" + ], + "equalsSign": false, + "typeDefinition": "" + } + ], + "usage": "[type] [commands...]", + "examples": [], + "commands": [ + { + "name": "help", + "description": "Show this help or the help of a sub-command.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "[command:command]", + "examples": [], + "commands": [] + } + ] + }, + { + "name": "use", + "description": "Automate document or project setup tasks.", + "options": [ + { + "name": "no-prompt", + "description": "Do not prompt to confirm actions", + "args": [], + "flags": [ + "--no-prompt" + ], + "equalsSign": false, + "typeDefinition": "" + } + ], + "usage": " [target:string]", + "examples": [], + "commands": [ + { + "name": "template", + "description": "Use a Quarto template for this directory or project.", + "options": [ + { + "name": "no-prompt", + "description": "Do not prompt to confirm actions", + "args": [], + "flags": [ + "--no-prompt" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log", + "description": "Path to log file", + "args": [ + { + "optional": false, + "name": "file", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-level", + "description": "Log level (info, warning, error, critical)", + "args": [ + { + "optional": false, + "name": "level", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-level" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-format", + "description": "Log format (plain, json-stream)", + "args": [ + { + "optional": false, + "name": "format", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-format" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "quiet", + "description": "Suppress console output.", + "args": [], + "flags": [ + "--quiet" + ], + "equalsSign": false, + "typeDefinition": "" + } + ], + "usage": "", + "examples": [ + { + "name": "Use a template from Github", + "description": "quarto use template /" + } + ], + "commands": [] + }, + { + "name": "binder", + "description": "Configure the current project with Binder support.", + "options": [ + { + "name": "no-prompt", + "description": "Do not prompt to confirm actions", + "args": [], + "flags": [ + "--no-prompt" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log", + "description": "Path to log file", + "args": [ + { + "optional": false, + "name": "file", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-level", + "description": "Log level (info, warning, error, critical)", + "args": [ + { + "optional": false, + "name": "level", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-level" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-format", + "description": "Log format (plain, json-stream)", + "args": [ + { + "optional": false, + "name": "format", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-format" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "quiet", + "description": "Suppress console output.", + "args": [], + "flags": [ + "--quiet" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "profile", + "description": "Active project profile(s)", + "args": [], + "flags": [ + "--profile" + ], + "equalsSign": false, + "typeDefinition": "" + } + ], + "usage": "", + "examples": [ + { + "name": "Configure project to use Binder", + "description": "quarto use binder" + } + ], + "commands": [] + } + ] + }, + { + "name": "add", + "description": "Add an extension to this folder or project", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + }, + { + "name": "no-prompt", + "description": "Do not prompt to confirm actions", + "args": [], + "flags": [ + "--no-prompt" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "name": "embed", + "description": "Embed this extension within another extension (used when authoring extensions).", + "args": [ + { + "optional": false, + "name": "extensionId", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--embed" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log", + "description": "Path to log file", + "args": [ + { + "optional": false, + "name": "file", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-level", + "description": "Log level (info, warning, error, critical)", + "args": [ + { + "optional": false, + "name": "level", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-level" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-format", + "description": "Log format (plain, json-stream)", + "args": [ + { + "optional": false, + "name": "format", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-format" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "quiet", + "description": "Suppress console output.", + "args": [], + "flags": [ + "--quiet" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "profile", + "description": "Active project profile(s)", + "args": [], + "flags": [ + "--profile" + ], + "equalsSign": false, + "typeDefinition": "" + } + ], + "usage": "", + "examples": [ + { + "name": "Install extension (Github)", + "description": "quarto add /" + }, + { + "name": "Install extension (file)", + "description": "quarto add " + }, + { + "name": "Install extension (url)", + "description": "quarto add " + } + ], + "commands": [ + { + "name": "help", + "description": "Show this help or the help of a sub-command.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "[command:command]", + "examples": [], + "commands": [] + } + ] + }, + { + "name": "update", + "description": "Updates an extension or global dependency.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + }, + { + "name": "no-prompt", + "description": "Do not prompt to confirm actions", + "args": [], + "flags": [ + "--no-prompt" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "name": "embed", + "description": "Embed this extension within another extension (used when authoring extensions).", + "args": [ + { + "optional": false, + "name": "extensionId", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--embed" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log", + "description": "Path to log file", + "args": [ + { + "optional": false, + "name": "file", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-level", + "description": "Log level (info, warning, error, critical)", + "args": [ + { + "optional": false, + "name": "level", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-level" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-format", + "description": "Log format (plain, json-stream)", + "args": [ + { + "optional": false, + "name": "format", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-format" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "quiet", + "description": "Suppress console output.", + "args": [], + "flags": [ + "--quiet" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "profile", + "description": "Active project profile(s)", + "args": [], + "flags": [ + "--profile" + ], + "equalsSign": false, + "typeDefinition": "" + } + ], + "usage": "[target...]", + "examples": [ + { + "name": "Update extension (Github)", + "description": "quarto update extension /" + }, + { + "name": "Update extension (file)", + "description": "quarto update extension " + }, + { + "name": "Update extension (url)", + "description": "quarto update extension " + }, + { + "name": "Update TinyTeX", + "description": "quarto update tool tinytex" + }, + { + "name": "Update Chromium", + "description": "quarto update tool chromium" + }, + { + "name": "Choose tool to update", + "description": "quarto update tool" + } + ], + "commands": [ + { + "name": "help", + "description": "Show this help or the help of a sub-command.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "[command:command]", + "examples": [], + "commands": [] + } + ] + }, + { + "name": "remove", + "description": "Removes an extension.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + }, + { + "name": "no-prompt", + "description": "Do not prompt to confirm actions", + "args": [], + "flags": [ + "--no-prompt" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "name": "embed", + "description": "Remove this extension from within another extension (used when authoring extensions).", + "args": [ + { + "optional": false, + "name": "extensionId", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--embed" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log", + "description": "Path to log file", + "args": [ + { + "optional": false, + "name": "file", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-level", + "description": "Log level (info, warning, error, critical)", + "args": [ + { + "optional": false, + "name": "level", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-level" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-format", + "description": "Log format (plain, json-stream)", + "args": [ + { + "optional": false, + "name": "format", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-format" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "quiet", + "description": "Suppress console output.", + "args": [], + "flags": [ + "--quiet" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "profile", + "description": "Active project profile(s)", + "args": [], + "flags": [ + "--profile" + ], + "equalsSign": false, + "typeDefinition": "" + } + ], + "usage": "[target...]", + "examples": [ + { + "name": "Remove extension using name", + "description": "quarto remove " + } + ], + "commands": [ + { + "name": "help", + "description": "Show this help or the help of a sub-command.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "[command:command]", + "examples": [], + "commands": [] + } + ] + }, + { + "name": "create-project", + "description": "Create a project for rendering multiple documents", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + }, + { + "name": "title", + "description": "Project title", + "args": [ + { + "optional": false, + "name": "title", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--title" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "name": "type", + "description": "Project type (book, default, website, manuscript)", + "args": [ + { + "optional": false, + "name": "type", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--type" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "name": "template", + "description": "Use a specific project template", + "args": [ + { + "optional": false, + "name": "type", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--template" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "name": "engine", + "description": "Use execution engine ([object Object], [object Object], [object Object], [object Object])", + "args": [ + { + "optional": false, + "name": "engine", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--engine" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "name": "editor", + "description": "Default editor for project ('source' or 'visual')", + "args": [ + { + "optional": false, + "name": "editor", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--editor" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "name": "with-venv", + "description": "Create a virtualenv for this project", + "args": [ + { + "optional": true, + "name": "packages", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--with-venv" + ], + "equalsSign": false, + "typeDefinition": "[packages:string]" + }, + { + "name": "with-condaenv", + "description": "Create a condaenv for this project", + "args": [ + { + "optional": true, + "name": "packages", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--with-condaenv" + ], + "equalsSign": false, + "typeDefinition": "[packages:string]" + }, + { + "name": "no-scaffold", + "description": "Don't create initial project file(s)", + "args": [], + "flags": [ + "--no-scaffold" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log", + "description": "Path to log file", + "args": [ + { + "optional": false, + "name": "file", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-level", + "description": "Log level (info, warning, error, critical)", + "args": [ + { + "optional": false, + "name": "level", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-level" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-format", + "description": "Log format (plain, json-stream)", + "args": [ + { + "optional": false, + "name": "format", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-format" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "quiet", + "description": "Suppress console output.", + "args": [], + "flags": [ + "--quiet" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "profile", + "description": "Active project profile(s)", + "args": [], + "flags": [ + "--profile" + ], + "equalsSign": false, + "typeDefinition": "" + } + ], + "usage": "[dir:string]", + "examples": [ + { + "name": "Create a project in the current directory", + "description": "quarto create-project" + }, + { + "name": "Create a project in the 'myproject' directory", + "description": "quarto create-project myproject" + }, + { + "name": "Create a website project", + "description": "quarto create-project mysite --type website" + }, + { + "name": "Create a blog project", + "description": "quarto create-project mysite --type website --template blog" + }, + { + "name": "Create a book project", + "description": "quarto create-project mybook --type book" + }, + { + "name": "Create a website project with jupyter", + "description": "quarto create-project mysite --type website --engine jupyter" + }, + { + "name": "Create a website project with jupyter + kernel", + "description": "quarto create-project mysite --type website --engine jupyter:python3" + }, + { + "name": "Create a book project with knitr", + "description": "quarto create-project mybook --type book --engine knitr" + }, + { + "name": "Create jupyter project with virtualenv", + "description": "quarto create-project myproject --engine jupyter --with-venv" + }, + { + "name": "Create jupyter project with virtualenv + packages", + "description": "quarto create-project myproject --engine jupyter --with-venv pandas,matplotlib" + }, + { + "name": "Create jupyter project with condaenv ", + "description": "quarto create-project myproject --engine jupyter --with-condaenv" + }, + { + "name": "Create jupyter project with condaenv + packages", + "description": "quarto create-project myproject --engine jupyter --with-condaenv pandas,matplotlib" + } + ], + "commands": [ + { + "name": "help", + "description": "Show this help or the help of a sub-command.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "[command:command]", + "examples": [], + "commands": [] + } + ] + }, + { + "name": "convert", + "description": "Convert documents to alternate representations.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + }, + { + "name": "output", + "description": "Write output to PATH.", + "args": [ + { + "optional": true, + "name": "path", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "-o", + "--output" + ], + "equalsSign": false, + "typeDefinition": "[path:string]", + "aliases": [ + "o" + ] + }, + { + "name": "with-ids", + "description": "Include ids in conversion", + "args": [], + "flags": [ + "--with-ids" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log", + "description": "Path to log file", + "args": [ + { + "optional": false, + "name": "file", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-level", + "description": "Log level (info, warning, error, critical)", + "args": [ + { + "optional": false, + "name": "level", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-level" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-format", + "description": "Log format (plain, json-stream)", + "args": [ + { + "optional": false, + "name": "format", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-format" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "quiet", + "description": "Suppress console output.", + "args": [], + "flags": [ + "--quiet" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "profile", + "description": "Active project profile(s)", + "args": [], + "flags": [ + "--profile" + ], + "equalsSign": false, + "typeDefinition": "" + } + ], + "usage": "", + "examples": [ + { + "name": "Convert notebook to markdown", + "description": "quarto convert mydocument.ipynb " + }, + { + "name": "Convert markdown to notebook", + "description": "quarto convert mydocument.qmd" + }, + { + "name": "Convert notebook to markdown, writing to file", + "description": "quarto convert mydocument.ipynb --output mydoc.qmd" + } + ], + "commands": [ + { + "name": "help", + "description": "Show this help or the help of a sub-command.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "[command:command]", + "examples": [], + "commands": [] + } + ] + }, + { + "name": "pandoc", + "description": "Run the version of Pandoc embedded within Quarto.\n\nYou can pass arbitrary command line arguments to quarto pandoc (they will\nbe passed through unmodified to Pandoc)", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + }, + { + "global": true, + "name": "log", + "description": "Path to log file", + "args": [ + { + "optional": false, + "name": "file", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-level", + "description": "Log level (info, warning, error, critical)", + "args": [ + { + "optional": false, + "name": "level", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-level" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-format", + "description": "Log format (plain, json-stream)", + "args": [ + { + "optional": false, + "name": "format", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-format" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "quiet", + "description": "Suppress console output.", + "args": [], + "flags": [ + "--quiet" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "profile", + "description": "Active project profile(s)", + "args": [], + "flags": [ + "--profile" + ], + "equalsSign": false, + "typeDefinition": "" + } + ], + "usage": "[...args]", + "examples": [ + { + "name": "Render markdown to HTML", + "description": "quarto pandoc document.md --to html --output document.html" + }, + { + "name": "List Pandoc output formats", + "description": "quarto pandoc --list-output-formats" + } + ], + "commands": [ + { + "name": "help", + "description": "Show this help or the help of a sub-command.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "[command:command]", + "examples": [], + "commands": [] + } + ] + }, + { + "name": "typst", + "description": "Run the version of Typst embedded within Quarto.\n\nYou can pass arbitrary command line arguments to quarto typst (they will\nbe passed through unmodified to Typst)", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + }, + { + "global": true, + "name": "log", + "description": "Path to log file", + "args": [ + { + "optional": false, + "name": "file", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-level", + "description": "Log level (info, warning, error, critical)", + "args": [ + { + "optional": false, + "name": "level", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-level" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-format", + "description": "Log format (plain, json-stream)", + "args": [ + { + "optional": false, + "name": "format", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-format" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "quiet", + "description": "Suppress console output.", + "args": [], + "flags": [ + "--quiet" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "profile", + "description": "Active project profile(s)", + "args": [], + "flags": [ + "--profile" + ], + "equalsSign": false, + "typeDefinition": "" + } + ], + "usage": "[...args]", + "examples": [ + { + "name": "Compile Typst to PDF", + "description": "quarto typst compile document.typ" + }, + { + "name": "List all discovered fonts in system and custom font paths", + "description": "quarto typst fonts" + } + ], + "commands": [ + { + "name": "help", + "description": "Show this help or the help of a sub-command.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "[command:command]", + "examples": [], + "commands": [] + } + ] + }, + { + "name": "run", + "description": "Run a TypeScript, R, Python, or Lua script.\n\nRun a utility script written in a variety of languages. For details, see:\nhttps://quarto.org/docs/projects/scripts.html#periodic-scripts", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + }, + { + "global": true, + "name": "log", + "description": "Path to log file", + "args": [ + { + "optional": false, + "name": "file", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-level", + "description": "Log level (info, warning, error, critical)", + "args": [ + { + "optional": false, + "name": "level", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-level" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-format", + "description": "Log format (plain, json-stream)", + "args": [ + { + "optional": false, + "name": "format", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-format" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "quiet", + "description": "Suppress console output.", + "args": [], + "flags": [ + "--quiet" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "profile", + "description": "Active project profile(s)", + "args": [], + "flags": [ + "--profile" + ], + "equalsSign": false, + "typeDefinition": "" + } + ], + "usage": "[script:string] [...args]", + "examples": [], + "commands": [ + { + "name": "help", + "description": "Show this help or the help of a sub-command.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "[command:command]", + "examples": [], + "commands": [] + } + ] + }, + { + "name": "list", + "description": "Lists an extension or global dependency.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + }, + { + "global": true, + "name": "log", + "description": "Path to log file", + "args": [ + { + "optional": false, + "name": "file", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-level", + "description": "Log level (info, warning, error, critical)", + "args": [ + { + "optional": false, + "name": "level", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-level" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-format", + "description": "Log format (plain, json-stream)", + "args": [ + { + "optional": false, + "name": "format", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-format" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "quiet", + "description": "Suppress console output.", + "args": [], + "flags": [ + "--quiet" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "profile", + "description": "Active project profile(s)", + "args": [], + "flags": [ + "--profile" + ], + "equalsSign": false, + "typeDefinition": "" + } + ], + "usage": "", + "examples": [ + { + "name": "List installed extensions", + "description": "quarto list extensions" + }, + { + "name": "List global tools", + "description": "quarto list tools" + } + ], + "commands": [ + { + "name": "help", + "description": "Show this help or the help of a sub-command.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "[command:command]", + "examples": [], + "commands": [] + } + ] + }, + { + "name": "install", + "description": "Installs a global dependency (TinyTex or Chromium).", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + }, + { + "name": "no-prompt", + "description": "Do not prompt to confirm actions", + "args": [], + "flags": [ + "--no-prompt" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "name": "update-path", + "description": "Update system path when a tool is installed", + "args": [], + "flags": [ + "--update-path" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log", + "description": "Path to log file", + "args": [ + { + "optional": false, + "name": "file", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-level", + "description": "Log level (info, warning, error, critical)", + "args": [ + { + "optional": false, + "name": "level", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-level" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-format", + "description": "Log format (plain, json-stream)", + "args": [ + { + "optional": false, + "name": "format", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-format" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "quiet", + "description": "Suppress console output.", + "args": [], + "flags": [ + "--quiet" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "profile", + "description": "Active project profile(s)", + "args": [], + "flags": [ + "--profile" + ], + "equalsSign": false, + "typeDefinition": "" + } + ], + "usage": "[target...]", + "examples": [ + { + "name": "Install TinyTeX", + "description": "quarto install tinytex" + }, + { + "name": "Install Chromium", + "description": "quarto install chromium" + }, + { + "name": "Choose tool to install", + "description": "quarto install" + } + ], + "commands": [ + { + "name": "help", + "description": "Show this help or the help of a sub-command.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "[command:command]", + "examples": [], + "commands": [] + } + ] + }, + { + "name": "uninstall", + "description": "Removes an extension.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + }, + { + "name": "no-prompt", + "description": "Do not prompt to confirm actions", + "args": [], + "flags": [ + "--no-prompt" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "name": "update-path", + "description": "Update system path when a tool is installed", + "args": [], + "flags": [ + "--update-path" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log", + "description": "Path to log file", + "args": [ + { + "optional": false, + "name": "file", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-level", + "description": "Log level (info, warning, error, critical)", + "args": [ + { + "optional": false, + "name": "level", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-level" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-format", + "description": "Log format (plain, json-stream)", + "args": [ + { + "optional": false, + "name": "format", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-format" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "quiet", + "description": "Suppress console output.", + "args": [], + "flags": [ + "--quiet" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "profile", + "description": "Active project profile(s)", + "args": [], + "flags": [ + "--profile" + ], + "equalsSign": false, + "typeDefinition": "" + } + ], + "usage": "[tool]", + "examples": [ + { + "name": "Remove extension using name", + "description": "quarto remove " + } + ], + "commands": [ + { + "name": "help", + "description": "Show this help or the help of a sub-command.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "[command:command]", + "examples": [], + "commands": [] + } + ] + }, + { + "name": "tools", + "description": "Display the status of Quarto installed dependencies", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "", + "examples": [ + { + "name": "Show tool status", + "description": "quarto tools" + } + ], + "commands": [ + { + "name": "help", + "description": "Show this help or the help of a sub-command.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "[command:command]", + "examples": [], + "commands": [] + } + ] + }, + { + "name": "publish", + "description": "Publish a document or project to a provider.\n\nAvailable providers include:\n\n - Quarto Pub (quarto-pub)\n - GitHub Pages (gh-pages)\n - Posit Connect (connect)\n - Posit Cloud (posit-cloud)\n - Netlify (netlify)\n - Confluence (confluence)\n - Hugging Face Spaces (huggingface)\n\nAccounts are configured interactively during publishing.\nManage/remove accounts with: quarto publish accounts", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + }, + { + "name": "id", + "description": "Identifier of content to publish", + "args": [ + { + "optional": false, + "name": "id", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--id" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "name": "server", + "description": "Server to publish to", + "args": [ + { + "optional": false, + "name": "server", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--server" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "name": "token", + "description": "Access token for publising provider", + "args": [ + { + "optional": false, + "name": "token", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--token" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "name": "no-render", + "description": "Do not render before publishing.", + "args": [], + "flags": [ + "--no-render" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "name": "no-prompt", + "description": "Do not prompt to confirm publishing destination", + "args": [], + "flags": [ + "--no-prompt" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "name": "no-browser", + "description": "Do not open a browser to the site after publishing", + "args": [], + "flags": [ + "--no-browser" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log", + "description": "Path to log file", + "args": [ + { + "optional": false, + "name": "file", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-level", + "description": "Log level (info, warning, error, critical)", + "args": [ + { + "optional": false, + "name": "level", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-level" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-format", + "description": "Log format (plain, json-stream)", + "args": [ + { + "optional": false, + "name": "format", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-format" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "quiet", + "description": "Suppress console output.", + "args": [], + "flags": [ + "--quiet" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "profile", + "description": "Active project profile(s)", + "args": [], + "flags": [ + "--profile" + ], + "equalsSign": false, + "typeDefinition": "" + } + ], + "usage": "[provider] [path]", + "examples": [ + { + "name": "Publish project (prompt for provider)", + "description": "quarto publish" + }, + { + "name": "Publish document (prompt for provider)", + "description": "quarto publish document.qmd" + }, + { + "name": "Publish project to Hugging Face Spaces", + "description": "quarto publish huggingface" + }, + { + "name": "Publish project to Netlify", + "description": "quarto publish netlify" + }, + { + "name": "Publish with explicit target", + "description": "quarto publish netlify --id DA36416-F950-4647-815C-01A24233E294" + }, + { + "name": "Publish project to GitHub Pages", + "description": "quarto publish gh-pages" + }, + { + "name": "Publish project to Posit Connect", + "description": "quarto publish connect" + }, + { + "name": "Publish with explicit credentials", + "description": "quarto publish connect --server example.com --token 01A24233E294" + }, + { + "name": "Publish project to Posit Cloud", + "description": "quarto publish posit-cloud" + }, + { + "name": "Publish without confirmation prompt", + "description": "quarto publish --no-prompt" + }, + { + "name": "Publish without rendering", + "description": "quarto publish --no-render" + }, + { + "name": "Publish without opening browser", + "description": "quarto publish --no-browser" + }, + { + "name": "Manage/remove publishing accounts", + "description": "quarto publish accounts" + } + ], + "commands": [ + { + "name": "help", + "description": "Show this help or the help of a sub-command.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "[command:command]", + "examples": [], + "commands": [] + } + ] + }, + { + "name": "capabilities", + "description": "Query for current capabilities (formats, engines, kernels etc.)", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + }, + { + "global": true, + "name": "log", + "description": "Path to log file", + "args": [ + { + "optional": false, + "name": "file", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-level", + "description": "Log level (info, warning, error, critical)", + "args": [ + { + "optional": false, + "name": "level", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-level" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-format", + "description": "Log format (plain, json-stream)", + "args": [ + { + "optional": false, + "name": "format", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-format" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "quiet", + "description": "Suppress console output.", + "args": [], + "flags": [ + "--quiet" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "profile", + "description": "Active project profile(s)", + "args": [], + "flags": [ + "--profile" + ], + "equalsSign": false, + "typeDefinition": "" + } + ], + "usage": "", + "examples": [], + "commands": [ + { + "name": "help", + "description": "Show this help or the help of a sub-command.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "[command:command]", + "examples": [], + "commands": [] + } + ] + }, + { + "name": "inspect", + "description": "Inspect a Quarto project or input path.\n\nInspecting a project returns its config and engines.\nInspecting an input path return its formats, engine, and dependent resources.\n\nEmits results of inspection as JSON to output (or stdout if not provided).", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + }, + { + "global": true, + "name": "log", + "description": "Path to log file", + "args": [ + { + "optional": false, + "name": "file", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-level", + "description": "Log level (info, warning, error, critical)", + "args": [ + { + "optional": false, + "name": "level", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-level" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-format", + "description": "Log format (plain, json-stream)", + "args": [ + { + "optional": false, + "name": "format", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-format" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "quiet", + "description": "Suppress console output.", + "args": [], + "flags": [ + "--quiet" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "profile", + "description": "Active project profile(s)", + "args": [], + "flags": [ + "--profile" + ], + "equalsSign": false, + "typeDefinition": "" + } + ], + "usage": "[path] [output]", + "examples": [ + { + "name": "Inspect project in current directory", + "description": "quarto inspect" + }, + { + "name": "Inspect project in directory", + "description": "quarto inspect myproject" + }, + { + "name": "Inspect input path", + "description": "quarto inspect document.md" + }, + { + "name": "Inspect input path and write to file", + "description": "quarto inspect document.md output.json" + } + ], + "commands": [ + { + "name": "help", + "description": "Show this help or the help of a sub-command.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "[command:command]", + "examples": [], + "commands": [] + } + ] + }, + { + "name": "check", + "description": "Verify correct functioning of Quarto installation.\n\nCheck specific functionality with argument install, jupyter, knitr, or all.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + }, + { + "name": "output", + "description": "Output as JSON to a file", + "args": [ + { + "optional": false, + "name": "path", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--output" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "name": "no-strict", + "description": "When set, will not fail if dependency versions don't match precisely", + "args": [], + "flags": [ + "--no-strict" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log", + "description": "Path to log file", + "args": [ + { + "optional": false, + "name": "file", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-level", + "description": "Log level (info, warning, error, critical)", + "args": [ + { + "optional": false, + "name": "level", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-level" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-format", + "description": "Log format (plain, json-stream)", + "args": [ + { + "optional": false, + "name": "format", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-format" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "quiet", + "description": "Suppress console output.", + "args": [], + "flags": [ + "--quiet" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "profile", + "description": "Active project profile(s)", + "args": [], + "flags": [ + "--profile" + ], + "equalsSign": false, + "typeDefinition": "" + } + ], + "usage": "[target:string]", + "examples": [ + { + "name": "Check Quarto installation", + "description": "quarto check install" + }, + { + "name": "Check Jupyter engine", + "description": "quarto check jupyter" + }, + { + "name": "Check Knitr engine", + "description": "quarto check knitr" + }, + { + "name": "Check installation and all engines", + "description": "quarto check all" + } + ], + "commands": [ + { + "name": "help", + "description": "Show this help or the help of a sub-command.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "[command:command]", + "examples": [], + "commands": [] + } + ] + }, + { + "name": "editor-support", + "description": "Miscellaneous tools to support Quarto editor modes", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "", + "examples": [], + "commands": [ + { + "name": "help", + "description": "Show this help or the help of a sub-command.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "[command:command]", + "examples": [], + "commands": [] + }, + { + "name": "crossref", + "description": "Index cross references for content", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + }, + { + "name": "input", + "description": "Use FILE as input (default: stdin).", + "args": [], + "flags": [ + "-i", + "--input" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "i" + ] + }, + { + "name": "output", + "description": "Write output to FILE (default: stdout).", + "args": [], + "flags": [ + "-o", + "--output" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "o" + ] + }, + { + "global": true, + "name": "log", + "description": "Path to log file", + "args": [ + { + "optional": false, + "name": "file", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-level", + "description": "Log level (info, warning, error, critical)", + "args": [ + { + "optional": false, + "name": "level", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-level" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-format", + "description": "Log format (plain, json-stream)", + "args": [ + { + "optional": false, + "name": "format", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-format" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "quiet", + "description": "Suppress console output.", + "args": [], + "flags": [ + "--quiet" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "profile", + "description": "Active project profile(s)", + "args": [], + "flags": [ + "--profile" + ], + "equalsSign": false, + "typeDefinition": "" + } + ], + "usage": "[...args]", + "examples": [], + "commands": [ + { + "name": "help", + "description": "Show this help or the help of a sub-command.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "[command:command]", + "examples": [], + "commands": [] + } + ] + } + ] + }, + { + "name": "call", + "description": "Access functions of Quarto subsystems such as its rendering engines.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "", + "examples": [], + "commands": [ + { + "name": "help", + "description": "Show this help or the help of a sub-command.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "[command:command]", + "examples": [], + "commands": [] + }, + { + "name": "engine", + "description": "Access functionality specific to quarto's different rendering engines.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + }, + { + "global": true, + "name": "log", + "description": "Path to log file", + "args": [ + { + "optional": false, + "name": "file", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-level", + "description": "Log level (info, warning, error, critical)", + "args": [ + { + "optional": false, + "name": "level", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-level" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-format", + "description": "Log format (plain, json-stream)", + "args": [ + { + "optional": false, + "name": "format", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-format" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "quiet", + "description": "Suppress console output.", + "args": [], + "flags": [ + "--quiet" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "profile", + "description": "Active project profile(s)", + "args": [], + "flags": [ + "--profile" + ], + "equalsSign": false, + "typeDefinition": "" + } + ], + "usage": "", + "examples": [], + "commands": [ + { + "name": "help", + "description": "Show this help or the help of a sub-command.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "[command:command]", + "examples": [], + "commands": [] + }, + { + "name": "julia", + "description": "Access functionality specific to the julia rendering engine.", + "options": [ + { + "global": true, + "name": "log", + "description": "Path to log file", + "args": [ + { + "optional": false, + "name": "file", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-level", + "description": "Log level (info, warning, error, critical)", + "args": [ + { + "optional": false, + "name": "level", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-level" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-format", + "description": "Log format (plain, json-stream)", + "args": [ + { + "optional": false, + "name": "format", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-format" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "quiet", + "description": "Suppress console output.", + "args": [], + "flags": [ + "--quiet" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "profile", + "description": "Active project profile(s)", + "args": [], + "flags": [ + "--profile" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "", + "examples": [], + "commands": [ + { + "name": "help", + "description": "Show this help or the help of a sub-command.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "[command:command]", + "examples": [], + "commands": [] + }, + { + "name": "status", + "description": "Get status information on the currently running Julia server process.", + "options": [ + { + "global": true, + "name": "log", + "description": "Path to log file", + "args": [ + { + "optional": false, + "name": "file", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-level", + "description": "Log level (info, warning, error, critical)", + "args": [ + { + "optional": false, + "name": "level", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-level" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-format", + "description": "Log format (plain, json-stream)", + "args": [ + { + "optional": false, + "name": "format", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-format" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "quiet", + "description": "Suppress console output.", + "args": [], + "flags": [ + "--quiet" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "profile", + "description": "Active project profile(s)", + "args": [], + "flags": [ + "--profile" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "", + "examples": [], + "commands": [ + { + "name": "help", + "description": "Show this help or the help of a sub-command.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "[command:command]", + "examples": [], + "commands": [] + } + ] + }, + { + "name": "kill", + "description": "Kill the control server if it is currently running. This will also kill all notebook worker processes.", + "options": [ + { + "global": true, + "name": "log", + "description": "Path to log file", + "args": [ + { + "optional": false, + "name": "file", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-level", + "description": "Log level (info, warning, error, critical)", + "args": [ + { + "optional": false, + "name": "level", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-level" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-format", + "description": "Log format (plain, json-stream)", + "args": [ + { + "optional": false, + "name": "format", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-format" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "quiet", + "description": "Suppress console output.", + "args": [], + "flags": [ + "--quiet" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "profile", + "description": "Active project profile(s)", + "args": [], + "flags": [ + "--profile" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "", + "examples": [], + "commands": [ + { + "name": "help", + "description": "Show this help or the help of a sub-command.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "[command:command]", + "examples": [], + "commands": [] + } + ] + }, + { + "name": "log", + "description": "Print the content of the julia server log file if it exists which can be used to diagnose problems.", + "options": [ + { + "global": true, + "name": "log", + "description": "Path to log file", + "args": [ + { + "optional": false, + "name": "file", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-level", + "description": "Log level (info, warning, error, critical)", + "args": [ + { + "optional": false, + "name": "level", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-level" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-format", + "description": "Log format (plain, json-stream)", + "args": [ + { + "optional": false, + "name": "format", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-format" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "quiet", + "description": "Suppress console output.", + "args": [], + "flags": [ + "--quiet" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "profile", + "description": "Active project profile(s)", + "args": [], + "flags": [ + "--profile" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "", + "examples": [], + "commands": [ + { + "name": "help", + "description": "Show this help or the help of a sub-command.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "[command:command]", + "examples": [], + "commands": [] + } + ] + }, + { + "name": "close", + "description": "Close the worker for a given notebook. If it is currently running, it will not be interrupted.", + "options": [ + { + "global": true, + "name": "log", + "description": "Path to log file", + "args": [ + { + "optional": false, + "name": "file", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-level", + "description": "Log level (info, warning, error, critical)", + "args": [ + { + "optional": false, + "name": "level", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-level" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-format", + "description": "Log format (plain, json-stream)", + "args": [ + { + "optional": false, + "name": "format", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-format" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "quiet", + "description": "Suppress console output.", + "args": [], + "flags": [ + "--quiet" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "profile", + "description": "Active project profile(s)", + "args": [], + "flags": [ + "--profile" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + }, + { + "default": false, + "name": "force", + "description": "Force closing. This will terminate the worker if it is running.", + "args": [], + "flags": [ + "-f", + "--force" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "f" + ] + } + ], + "usage": "", + "examples": [], + "commands": [ + { + "name": "help", + "description": "Show this help or the help of a sub-command.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "[command:command]", + "examples": [], + "commands": [] + } + ] + }, + { + "name": "stop", + "description": "Send a message to the server that it should close all notebooks and exit. This will fail if any notebooks are not idle.", + "options": [ + { + "global": true, + "name": "log", + "description": "Path to log file", + "args": [ + { + "optional": false, + "name": "file", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-level", + "description": "Log level (info, warning, error, critical)", + "args": [ + { + "optional": false, + "name": "level", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-level" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-format", + "description": "Log format (plain, json-stream)", + "args": [ + { + "optional": false, + "name": "format", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-format" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "quiet", + "description": "Suppress console output.", + "args": [], + "flags": [ + "--quiet" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "profile", + "description": "Active project profile(s)", + "args": [], + "flags": [ + "--profile" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "", + "examples": [], + "commands": [ + { + "name": "help", + "description": "Show this help or the help of a sub-command.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "[command:command]", + "examples": [], + "commands": [] + } + ] + } + ] + } + ] + } + ] + }, + { + "name": "dev-call", + "description": "Access internals of Quarto - this command is not intended for general use.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "", + "examples": [], + "commands": [ + { + "name": "help", + "description": "Show this help or the help of a sub-command.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "[command:command]", + "examples": [], + "commands": [] + }, + { + "name": "cli-info", + "description": "Generate JSON information about the Quarto CLI.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + }, + { + "global": true, + "name": "log", + "description": "Path to log file", + "args": [ + { + "optional": false, + "name": "file", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-level", + "description": "Log level (info, warning, error, critical)", + "args": [ + { + "optional": false, + "name": "level", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-level" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "log-format", + "description": "Log format (plain, json-stream)", + "args": [ + { + "optional": false, + "name": "format", + "action": "string", + "variadic": false, + "list": false, + "type": "string" + } + ], + "flags": [ + "--log-format" + ], + "equalsSign": false, + "typeDefinition": "" + }, + { + "global": true, + "name": "quiet", + "description": "Suppress console output.", + "args": [], + "flags": [ + "--quiet" + ], + "equalsSign": false, + "typeDefinition": "" + } + ], + "usage": "", + "examples": [], + "commands": [ + { + "name": "help", + "description": "Show this help or the help of a sub-command.", + "options": [ + { + "standalone": true, + "global": true, + "prepend": true, + "name": "help", + "description": "Show this help.", + "args": [], + "flags": [ + "-h", + "--help" + ], + "equalsSign": false, + "typeDefinition": "", + "aliases": [ + "h" + ] + } + ], + "usage": "[command:command]", + "examples": [], + "commands": [] + } + ] + } + ] + } + ] +} From ab6c685436f83a33bc5f42b330fe3a8701b2ce32 Mon Sep 17 00:00:00 2001 From: Carlos Scheidegger Date: Wed, 30 Apr 2025 15:46:28 -0400 Subject: [PATCH 02/18] cli skeleton --- docs/cli/add.qmd | 3 +++ docs/cli/call.qmd | 3 +++ docs/cli/capabilities.qmd | 3 +++ docs/cli/check.qmd | 3 +++ docs/cli/convert.qmd | 3 +++ docs/cli/create-project.qmd | 3 +++ docs/cli/create.qmd | 3 +++ docs/cli/dev-call.qmd | 3 +++ docs/cli/editor-support.qmd | 3 +++ docs/cli/inspect.qmd | 3 +++ docs/cli/install.qmd | 3 +++ docs/cli/list.qmd | 3 +++ docs/cli/pandoc.qmd | 3 +++ docs/cli/preview.qmd | 3 +++ docs/cli/publish.qmd | 3 +++ docs/cli/remove.qmd | 3 +++ docs/cli/render.qmd | 3 +++ docs/cli/run.qmd | 3 +++ docs/cli/serve.qmd | 3 +++ docs/cli/tools.qmd | 3 +++ docs/cli/typst.qmd | 3 +++ docs/cli/uninstall.qmd | 3 +++ docs/cli/update.qmd | 3 +++ docs/cli/use.qmd | 3 +++ 24 files changed, 72 insertions(+) create mode 100644 docs/cli/add.qmd create mode 100644 docs/cli/call.qmd create mode 100644 docs/cli/capabilities.qmd create mode 100644 docs/cli/check.qmd create mode 100644 docs/cli/convert.qmd create mode 100644 docs/cli/create-project.qmd create mode 100644 docs/cli/create.qmd create mode 100644 docs/cli/dev-call.qmd create mode 100644 docs/cli/editor-support.qmd create mode 100644 docs/cli/inspect.qmd create mode 100644 docs/cli/install.qmd create mode 100644 docs/cli/list.qmd create mode 100644 docs/cli/pandoc.qmd create mode 100644 docs/cli/preview.qmd create mode 100644 docs/cli/publish.qmd create mode 100644 docs/cli/remove.qmd create mode 100644 docs/cli/render.qmd create mode 100644 docs/cli/run.qmd create mode 100644 docs/cli/serve.qmd create mode 100644 docs/cli/tools.qmd create mode 100644 docs/cli/typst.qmd create mode 100644 docs/cli/uninstall.qmd create mode 100644 docs/cli/update.qmd create mode 100644 docs/cli/use.qmd diff --git a/docs/cli/add.qmd b/docs/cli/add.qmd new file mode 100644 index 0000000000..9ed4399c95 --- /dev/null +++ b/docs/cli/add.qmd @@ -0,0 +1,3 @@ +--- +title: add +--- diff --git a/docs/cli/call.qmd b/docs/cli/call.qmd new file mode 100644 index 0000000000..8eadd376f4 --- /dev/null +++ b/docs/cli/call.qmd @@ -0,0 +1,3 @@ +--- +title: call +--- diff --git a/docs/cli/capabilities.qmd b/docs/cli/capabilities.qmd new file mode 100644 index 0000000000..a3b119603c --- /dev/null +++ b/docs/cli/capabilities.qmd @@ -0,0 +1,3 @@ +--- +title: capabilities +--- diff --git a/docs/cli/check.qmd b/docs/cli/check.qmd new file mode 100644 index 0000000000..a21ebbfc3a --- /dev/null +++ b/docs/cli/check.qmd @@ -0,0 +1,3 @@ +--- +title: check +--- diff --git a/docs/cli/convert.qmd b/docs/cli/convert.qmd new file mode 100644 index 0000000000..7138a6907c --- /dev/null +++ b/docs/cli/convert.qmd @@ -0,0 +1,3 @@ +--- +title: convert +--- diff --git a/docs/cli/create-project.qmd b/docs/cli/create-project.qmd new file mode 100644 index 0000000000..ca9ea91019 --- /dev/null +++ b/docs/cli/create-project.qmd @@ -0,0 +1,3 @@ +--- +title: create-project +--- diff --git a/docs/cli/create.qmd b/docs/cli/create.qmd new file mode 100644 index 0000000000..26cb6196fb --- /dev/null +++ b/docs/cli/create.qmd @@ -0,0 +1,3 @@ +--- +title: create +--- diff --git a/docs/cli/dev-call.qmd b/docs/cli/dev-call.qmd new file mode 100644 index 0000000000..82d3e106ea --- /dev/null +++ b/docs/cli/dev-call.qmd @@ -0,0 +1,3 @@ +--- +title: dev-call +--- diff --git a/docs/cli/editor-support.qmd b/docs/cli/editor-support.qmd new file mode 100644 index 0000000000..65069a2efd --- /dev/null +++ b/docs/cli/editor-support.qmd @@ -0,0 +1,3 @@ +--- +title: editor-support +--- diff --git a/docs/cli/inspect.qmd b/docs/cli/inspect.qmd new file mode 100644 index 0000000000..8c1b8ffff1 --- /dev/null +++ b/docs/cli/inspect.qmd @@ -0,0 +1,3 @@ +--- +title: inspect +--- diff --git a/docs/cli/install.qmd b/docs/cli/install.qmd new file mode 100644 index 0000000000..fb396b31b8 --- /dev/null +++ b/docs/cli/install.qmd @@ -0,0 +1,3 @@ +--- +title: install +--- diff --git a/docs/cli/list.qmd b/docs/cli/list.qmd new file mode 100644 index 0000000000..70224fe8ec --- /dev/null +++ b/docs/cli/list.qmd @@ -0,0 +1,3 @@ +--- +title: list +--- diff --git a/docs/cli/pandoc.qmd b/docs/cli/pandoc.qmd new file mode 100644 index 0000000000..6e15ea0df0 --- /dev/null +++ b/docs/cli/pandoc.qmd @@ -0,0 +1,3 @@ +--- +title: pandoc +--- diff --git a/docs/cli/preview.qmd b/docs/cli/preview.qmd new file mode 100644 index 0000000000..1c2357416e --- /dev/null +++ b/docs/cli/preview.qmd @@ -0,0 +1,3 @@ +--- +title: preview +--- diff --git a/docs/cli/publish.qmd b/docs/cli/publish.qmd new file mode 100644 index 0000000000..b9d54a1dfa --- /dev/null +++ b/docs/cli/publish.qmd @@ -0,0 +1,3 @@ +--- +title: publish +--- diff --git a/docs/cli/remove.qmd b/docs/cli/remove.qmd new file mode 100644 index 0000000000..36b34a89cf --- /dev/null +++ b/docs/cli/remove.qmd @@ -0,0 +1,3 @@ +--- +title: remove +--- diff --git a/docs/cli/render.qmd b/docs/cli/render.qmd new file mode 100644 index 0000000000..1a5d4f2d0a --- /dev/null +++ b/docs/cli/render.qmd @@ -0,0 +1,3 @@ +--- +title: render +--- diff --git a/docs/cli/run.qmd b/docs/cli/run.qmd new file mode 100644 index 0000000000..d07d135aad --- /dev/null +++ b/docs/cli/run.qmd @@ -0,0 +1,3 @@ +--- +title: run +--- diff --git a/docs/cli/serve.qmd b/docs/cli/serve.qmd new file mode 100644 index 0000000000..0b370f2728 --- /dev/null +++ b/docs/cli/serve.qmd @@ -0,0 +1,3 @@ +--- +title: serve +--- diff --git a/docs/cli/tools.qmd b/docs/cli/tools.qmd new file mode 100644 index 0000000000..ba9e2b5f3a --- /dev/null +++ b/docs/cli/tools.qmd @@ -0,0 +1,3 @@ +--- +title: tools +--- diff --git a/docs/cli/typst.qmd b/docs/cli/typst.qmd new file mode 100644 index 0000000000..8faaa047d6 --- /dev/null +++ b/docs/cli/typst.qmd @@ -0,0 +1,3 @@ +--- +title: typst +--- diff --git a/docs/cli/uninstall.qmd b/docs/cli/uninstall.qmd new file mode 100644 index 0000000000..3ad0e2e15e --- /dev/null +++ b/docs/cli/uninstall.qmd @@ -0,0 +1,3 @@ +--- +title: uninstall +--- diff --git a/docs/cli/update.qmd b/docs/cli/update.qmd new file mode 100644 index 0000000000..8cef1e90c1 --- /dev/null +++ b/docs/cli/update.qmd @@ -0,0 +1,3 @@ +--- +title: update +--- diff --git a/docs/cli/use.qmd b/docs/cli/use.qmd new file mode 100644 index 0000000000..cce5dca17f --- /dev/null +++ b/docs/cli/use.qmd @@ -0,0 +1,3 @@ +--- +title: use +--- From 3510de6aaa44160407cc7e1bc8fc22a50fd77f9c Mon Sep 17 00:00:00 2001 From: Charlotte Wickham Date: Wed, 7 May 2025 16:00:49 -0700 Subject: [PATCH 03/18] Auto-gen markdown --- _quarto.yml | 2 + docs/cli/_add.md | 45 +++++++++++++ docs/cli/_call.md | 21 +++++++ docs/cli/_capabilities.md | 25 ++++++++ docs/cli/_check.md | 53 ++++++++++++++++ docs/cli/_convert.md | 45 +++++++++++++ docs/cli/_create-project.md | 105 +++++++++++++++++++++++++++++++ docs/cli/_create.md | 28 +++++++++ docs/cli/_dev-call.md | 21 +++++++ docs/cli/_editor-support.md | 21 +++++++ docs/cli/_inspect.md | 54 ++++++++++++++++ docs/cli/_install.md | 45 +++++++++++++ docs/cli/_list.md | 37 +++++++++++ docs/cli/_metadata.yml | 1 + docs/cli/_pandoc.md | 40 ++++++++++++ docs/cli/_preview.md | 92 +++++++++++++++++++++++++++ docs/cli/_publish.md | 122 ++++++++++++++++++++++++++++++++++++ docs/cli/_remove.md | 33 ++++++++++ docs/cli/_render.md | 79 +++++++++++++++++++++++ docs/cli/_run.md | 28 +++++++++ docs/cli/_serve.md | 43 +++++++++++++ docs/cli/_tools.md | 26 ++++++++ docs/cli/_typst.md | 40 ++++++++++++ docs/cli/_uninstall.md | 33 ++++++++++ docs/cli/_update.md | 63 +++++++++++++++++++ docs/cli/_use.md | 21 +++++++ docs/cli/add.qmd | 5 +- docs/cli/call.qmd | 5 +- docs/cli/capabilities.qmd | 5 +- docs/cli/check.qmd | 5 +- docs/cli/convert.qmd | 5 +- docs/cli/create-project.qmd | 5 +- docs/cli/create.qmd | 5 +- docs/cli/dev-call.qmd | 5 +- docs/cli/editor-support.qmd | 5 +- docs/cli/generate-md.R | 110 ++++++++++++++++++++++++++++++++ docs/cli/inspect.qmd | 5 +- docs/cli/install.qmd | 5 +- docs/cli/list.qmd | 5 +- docs/cli/pandoc.qmd | 5 +- docs/cli/preview.qmd | 5 +- docs/cli/publish.qmd | 5 +- docs/cli/remove.qmd | 5 +- docs/cli/render.qmd | 5 +- docs/cli/run.qmd | 5 +- docs/cli/serve.qmd | 5 +- docs/cli/tmp.md | 79 +++++++++++++++++++++++ docs/cli/tools.qmd | 5 +- docs/cli/typst.qmd | 5 +- docs/cli/uninstall.qmd | 5 +- docs/cli/update.qmd | 5 +- docs/cli/use.qmd | 5 +- 52 files changed, 1408 insertions(+), 24 deletions(-) create mode 100644 docs/cli/_add.md create mode 100644 docs/cli/_call.md create mode 100644 docs/cli/_capabilities.md create mode 100644 docs/cli/_check.md create mode 100644 docs/cli/_convert.md create mode 100644 docs/cli/_create-project.md create mode 100644 docs/cli/_create.md create mode 100644 docs/cli/_dev-call.md create mode 100644 docs/cli/_editor-support.md create mode 100644 docs/cli/_inspect.md create mode 100644 docs/cli/_install.md create mode 100644 docs/cli/_list.md create mode 100644 docs/cli/_metadata.yml create mode 100644 docs/cli/_pandoc.md create mode 100644 docs/cli/_preview.md create mode 100644 docs/cli/_publish.md create mode 100644 docs/cli/_remove.md create mode 100644 docs/cli/_render.md create mode 100644 docs/cli/_run.md create mode 100644 docs/cli/_serve.md create mode 100644 docs/cli/_tools.md create mode 100644 docs/cli/_typst.md create mode 100644 docs/cli/_uninstall.md create mode 100644 docs/cli/_update.md create mode 100644 docs/cli/_use.md create mode 100644 docs/cli/generate-md.R create mode 100644 docs/cli/tmp.md diff --git a/_quarto.yml b/_quarto.yml index 5fcba34acf..f8af6f4726 100644 --- a/_quarto.yml +++ b/_quarto.yml @@ -588,6 +588,8 @@ website: href: docs/reference/metadata/crossref.qmd - text: "Brand" href: docs/reference/metadata/brand.qmd + - section: CLI Commands + contents: docs/cli/*.qmd - id: prerelease title: "Quarto 1.3" contents: diff --git a/docs/cli/_add.md b/docs/cli/_add.md new file mode 100644 index 0000000000..6cc0e9e913 --- /dev/null +++ b/docs/cli/_add.md @@ -0,0 +1,45 @@ +Add an extension to this folder or project + +``` {.bash} +quarto add +``` + + +## Options + +|Flags |Arguments |Description | +|:--------------|:---------------|:-------------------------------------------------------------------------------| +|`-h`, `--help` | |Show this help. | +|`--no-prompt` | |Do not prompt to confirm actions | +|`--embed` |`` |Embed this extension within another extension (used when authoring extensions). | +|`--log` |`` |Path to log file | +|`--log-level` |`` |Log level (info, warning, error, critical) | +|`--log-format` |`` |Log format (plain, json-stream) | +|`--quiet` | |Suppress console output. | +|`--profile` | |Active project profile(s) | +## Commands + +|Command |Description | +|:-------|:--------------------------------------------| +|`help` |Show this help or the help of a sub-command. | + + +## Examples +### Install extension (Github) + +``` {.bash filename='Terminal'} +quarto add / +``` +## Examples +### Install extension (file) + +``` {.bash filename='Terminal'} +quarto add +``` +## Examples +### Install extension (url) + +``` {.bash filename='Terminal'} +quarto add +``` + diff --git a/docs/cli/_call.md b/docs/cli/_call.md new file mode 100644 index 0000000000..9662e1be01 --- /dev/null +++ b/docs/cli/_call.md @@ -0,0 +1,21 @@ +Access functions of Quarto subsystems such as its rendering engines. + +``` {.bash} +quarto call +``` + + +## Options + +|Flags |Arguments |Description | +|:--------------|:---------|:---------------| +|`-h`, `--help` | |Show this help. | +## Commands + +|Command |Description | +|:--------|:----------------------------------------------------------------------| +|`help` |Show this help or the help of a sub-command. | +|`engine` |Access functionality specific to quarto's different rendering engines. | + + + diff --git a/docs/cli/_capabilities.md b/docs/cli/_capabilities.md new file mode 100644 index 0000000000..4447c11262 --- /dev/null +++ b/docs/cli/_capabilities.md @@ -0,0 +1,25 @@ +Query for current capabilities (formats, engines, kernels etc.) + +``` {.bash} +quarto capabilities +``` + + +## Options + +|Flags |Arguments |Description | +|:--------------|:----------|:------------------------------------------| +|`-h`, `--help` | |Show this help. | +|`--log` |`` |Path to log file | +|`--log-level` |`` |Log level (info, warning, error, critical) | +|`--log-format` |`` |Log format (plain, json-stream) | +|`--quiet` | |Suppress console output. | +|`--profile` | |Active project profile(s) | +## Commands + +|Command |Description | +|:-------|:--------------------------------------------| +|`help` |Show this help or the help of a sub-command. | + + + diff --git a/docs/cli/_check.md b/docs/cli/_check.md new file mode 100644 index 0000000000..5afa168d0e --- /dev/null +++ b/docs/cli/_check.md @@ -0,0 +1,53 @@ +Verify correct functioning of Quarto installation. + +Check specific functionality with argument install, jupyter, knitr, or all. + +``` {.bash} +quarto check [target:string] +``` + + +## Options + +|Flags |Arguments |Description | +|:--------------|:----------|:--------------------------------------------------------------------| +|`-h`, `--help` | |Show this help. | +|`--output` |`` |Output as JSON to a file | +|`--no-strict` | |When set, will not fail if dependency versions don't match precisely | +|`--log` |`` |Path to log file | +|`--log-level` |`` |Log level (info, warning, error, critical) | +|`--log-format` |`` |Log format (plain, json-stream) | +|`--quiet` | |Suppress console output. | +|`--profile` | |Active project profile(s) | +## Commands + +|Command |Description | +|:-------|:--------------------------------------------| +|`help` |Show this help or the help of a sub-command. | + + +## Examples +### Check Quarto installation + +``` {.bash filename='Terminal'} +quarto check install +``` +## Examples +### Check Jupyter engine + +``` {.bash filename='Terminal'} +quarto check jupyter +``` +## Examples +### Check Knitr engine + +``` {.bash filename='Terminal'} +quarto check knitr +``` +## Examples +### Check installation and all engines + +``` {.bash filename='Terminal'} +quarto check all +``` + diff --git a/docs/cli/_convert.md b/docs/cli/_convert.md new file mode 100644 index 0000000000..65b11e9b48 --- /dev/null +++ b/docs/cli/_convert.md @@ -0,0 +1,45 @@ +Convert documents to alternate representations. + +``` {.bash} +quarto convert +``` + + +## Options + +|Flags |Arguments |Description | +|:----------------|:---------------|:------------------------------------------| +|`-h`, `--help` | |Show this help. | +|`-o`, `--output` |`[path:string]` |Write output to PATH. | +|`--with-ids` | |Include ids in conversion | +|`--log` |`` |Path to log file | +|`--log-level` |`` |Log level (info, warning, error, critical) | +|`--log-format` |`` |Log format (plain, json-stream) | +|`--quiet` | |Suppress console output. | +|`--profile` | |Active project profile(s) | +## Commands + +|Command |Description | +|:-------|:--------------------------------------------| +|`help` |Show this help or the help of a sub-command. | + + +## Examples +### Convert notebook to markdown + +``` {.bash filename='Terminal'} +quarto convert mydocument.ipynb +``` +## Examples +### Convert markdown to notebook + +``` {.bash filename='Terminal'} +quarto convert mydocument.qmd +``` +## Examples +### Convert notebook to markdown, writing to file + +``` {.bash filename='Terminal'} +quarto convert mydocument.ipynb --output mydoc.qmd +``` + diff --git a/docs/cli/_create-project.md b/docs/cli/_create-project.md new file mode 100644 index 0000000000..f2a09bd0d8 --- /dev/null +++ b/docs/cli/_create-project.md @@ -0,0 +1,105 @@ +Create a project for rendering multiple documents + +``` {.bash} +quarto create-project [dir:string] +``` + + +## Options + +|Flags |Arguments |Description | +|:-----------------|:-------------------|:-----------------------------------------------------------------------------------------| +|`-h`, `--help` | |Show this help. | +|`--title` |`` |Project title | +|`--type` |`` |Project type (book, default, website, manuscript) | +|`--template` |`` |Use a specific project template | +|`--engine` |`` |Use execution engine ([object Object], [object Object], [object Object], [object Object]) | +|`--editor` |`` |Default editor for project ('source' or 'visual') | +|`--with-venv` |`[packages:string]` |Create a virtualenv for this project | +|`--with-condaenv` |`[packages:string]` |Create a condaenv for this project | +|`--no-scaffold` | |Don't create initial project file(s) | +|`--log` |`` |Path to log file | +|`--log-level` |`` |Log level (info, warning, error, critical) | +|`--log-format` |`` |Log format (plain, json-stream) | +|`--quiet` | |Suppress console output. | +|`--profile` | |Active project profile(s) | +## Commands + +|Command |Description | +|:-------|:--------------------------------------------| +|`help` |Show this help or the help of a sub-command. | + + +## Examples +### Create a project in the current directory + +``` {.bash filename='Terminal'} +quarto create-project +``` +## Examples +### Create a project in the 'myproject' directory + +``` {.bash filename='Terminal'} +quarto create-project myproject +``` +## Examples +### Create a website project + +``` {.bash filename='Terminal'} +quarto create-project mysite --type website +``` +## Examples +### Create a blog project + +``` {.bash filename='Terminal'} +quarto create-project mysite --type website --template blog +``` +## Examples +### Create a book project + +``` {.bash filename='Terminal'} +quarto create-project mybook --type book +``` +## Examples +### Create a website project with jupyter + +``` {.bash filename='Terminal'} +quarto create-project mysite --type website --engine jupyter +``` +## Examples +### Create a website project with jupyter + kernel + +``` {.bash filename='Terminal'} +quarto create-project mysite --type website --engine jupyter:python3 +``` +## Examples +### Create a book project with knitr + +``` {.bash filename='Terminal'} +quarto create-project mybook --type book --engine knitr +``` +## Examples +### Create jupyter project with virtualenv + +``` {.bash filename='Terminal'} +quarto create-project myproject --engine jupyter --with-venv +``` +## Examples +### Create jupyter project with virtualenv + packages + +``` {.bash filename='Terminal'} +quarto create-project myproject --engine jupyter --with-venv pandas,matplotlib +``` +## Examples +### Create jupyter project with condaenv + +``` {.bash filename='Terminal'} +quarto create-project myproject --engine jupyter --with-condaenv +``` +## Examples +### Create jupyter project with condaenv + packages + +``` {.bash filename='Terminal'} +quarto create-project myproject --engine jupyter --with-condaenv pandas,matplotlib +``` + diff --git a/docs/cli/_create.md b/docs/cli/_create.md new file mode 100644 index 0000000000..e82feeceaa --- /dev/null +++ b/docs/cli/_create.md @@ -0,0 +1,28 @@ +Create a Quarto project or extension + +``` {.bash} +quarto create [type] [commands...] +``` + + +## Options + +|Flags |Arguments |Description | +|:--------------|:-----------------|:------------------------------------------------------------| +|`-h`, `--help` | |Show this help. | +|`--open` |`[editor:string]` |Open new artifact in this editor (positron, vscode, rstudio) | +|`--no-open` | |Do not open in an editor | +|`--no-prompt` | |Do not prompt to confirm actions | +|`--log` |`` |Path to log file | +|`--log-level` |`` |Log level (info, warning, error, critical) | +|`--log-format` |`` |Log format (plain, json-stream) | +|`--quiet` | |Suppress console output. | +|`--profile` | |Active project profile(s) | +## Commands + +|Command |Description | +|:-------|:--------------------------------------------| +|`help` |Show this help or the help of a sub-command. | + + + diff --git a/docs/cli/_dev-call.md b/docs/cli/_dev-call.md new file mode 100644 index 0000000000..32c79bf7d0 --- /dev/null +++ b/docs/cli/_dev-call.md @@ -0,0 +1,21 @@ +Access internals of Quarto - this command is not intended for general use. + +``` {.bash} +quarto dev-call +``` + + +## Options + +|Flags |Arguments |Description | +|:--------------|:---------|:---------------| +|`-h`, `--help` | |Show this help. | +## Commands + +|Command |Description | +|:----------|:-----------------------------------------------| +|`help` |Show this help or the help of a sub-command. | +|`cli-info` |Generate JSON information about the Quarto CLI. | + + + diff --git a/docs/cli/_editor-support.md b/docs/cli/_editor-support.md new file mode 100644 index 0000000000..e9b2471bef --- /dev/null +++ b/docs/cli/_editor-support.md @@ -0,0 +1,21 @@ +Miscellaneous tools to support Quarto editor modes + +``` {.bash} +quarto editor-support +``` + + +## Options + +|Flags |Arguments |Description | +|:--------------|:---------|:---------------| +|`-h`, `--help` | |Show this help. | +## Commands + +|Command |Description | +|:----------|:--------------------------------------------| +|`help` |Show this help or the help of a sub-command. | +|`crossref` |Index cross references for content | + + + diff --git a/docs/cli/_inspect.md b/docs/cli/_inspect.md new file mode 100644 index 0000000000..6407f8999e --- /dev/null +++ b/docs/cli/_inspect.md @@ -0,0 +1,54 @@ +Inspect a Quarto project or input path. + +Inspecting a project returns its config and engines. +Inspecting an input path return its formats, engine, and dependent resources. + +Emits results of inspection as JSON to output (or stdout if not provided). + +``` {.bash} +quarto inspect [path] [output] +``` + + +## Options + +|Flags |Arguments |Description | +|:--------------|:----------|:------------------------------------------| +|`-h`, `--help` | |Show this help. | +|`--log` |`` |Path to log file | +|`--log-level` |`` |Log level (info, warning, error, critical) | +|`--log-format` |`` |Log format (plain, json-stream) | +|`--quiet` | |Suppress console output. | +|`--profile` | |Active project profile(s) | +## Commands + +|Command |Description | +|:-------|:--------------------------------------------| +|`help` |Show this help or the help of a sub-command. | + + +## Examples +### Inspect project in current directory + +``` {.bash filename='Terminal'} +quarto inspect +``` +## Examples +### Inspect project in directory + +``` {.bash filename='Terminal'} +quarto inspect myproject +``` +## Examples +### Inspect input path + +``` {.bash filename='Terminal'} +quarto inspect document.md +``` +## Examples +### Inspect input path and write to file + +``` {.bash filename='Terminal'} +quarto inspect document.md output.json +``` + diff --git a/docs/cli/_install.md b/docs/cli/_install.md new file mode 100644 index 0000000000..7e25fff8e9 --- /dev/null +++ b/docs/cli/_install.md @@ -0,0 +1,45 @@ +Installs a global dependency (TinyTex or Chromium). + +``` {.bash} +quarto install [target...] +``` + + +## Options + +|Flags |Arguments |Description | +|:---------------|:----------|:-------------------------------------------| +|`-h`, `--help` | |Show this help. | +|`--no-prompt` | |Do not prompt to confirm actions | +|`--update-path` | |Update system path when a tool is installed | +|`--log` |`` |Path to log file | +|`--log-level` |`` |Log level (info, warning, error, critical) | +|`--log-format` |`` |Log format (plain, json-stream) | +|`--quiet` | |Suppress console output. | +|`--profile` | |Active project profile(s) | +## Commands + +|Command |Description | +|:-------|:--------------------------------------------| +|`help` |Show this help or the help of a sub-command. | + + +## Examples +### Install TinyTeX + +``` {.bash filename='Terminal'} +quarto install tinytex +``` +## Examples +### Install Chromium + +``` {.bash filename='Terminal'} +quarto install chromium +``` +## Examples +### Choose tool to install + +``` {.bash filename='Terminal'} +quarto install +``` + diff --git a/docs/cli/_list.md b/docs/cli/_list.md new file mode 100644 index 0000000000..9390515468 --- /dev/null +++ b/docs/cli/_list.md @@ -0,0 +1,37 @@ +Lists an extension or global dependency. + +``` {.bash} +quarto list +``` + + +## Options + +|Flags |Arguments |Description | +|:--------------|:----------|:------------------------------------------| +|`-h`, `--help` | |Show this help. | +|`--log` |`` |Path to log file | +|`--log-level` |`` |Log level (info, warning, error, critical) | +|`--log-format` |`` |Log format (plain, json-stream) | +|`--quiet` | |Suppress console output. | +|`--profile` | |Active project profile(s) | +## Commands + +|Command |Description | +|:-------|:--------------------------------------------| +|`help` |Show this help or the help of a sub-command. | + + +## Examples +### List installed extensions + +``` {.bash filename='Terminal'} +quarto list extensions +``` +## Examples +### List global tools + +``` {.bash filename='Terminal'} +quarto list tools +``` + diff --git a/docs/cli/_metadata.yml b/docs/cli/_metadata.yml new file mode 100644 index 0000000000..0ede0e08a6 --- /dev/null +++ b/docs/cli/_metadata.yml @@ -0,0 +1 @@ +tbl-colwidths: [35,20,45] \ No newline at end of file diff --git a/docs/cli/_pandoc.md b/docs/cli/_pandoc.md new file mode 100644 index 0000000000..7f54dac843 --- /dev/null +++ b/docs/cli/_pandoc.md @@ -0,0 +1,40 @@ +Run the version of Pandoc embedded within Quarto. + +You can pass arbitrary command line arguments to quarto pandoc (they will +be passed through unmodified to Pandoc) + +``` {.bash} +quarto pandoc [...args] +``` + + +## Options + +|Flags |Arguments |Description | +|:--------------|:----------|:------------------------------------------| +|`-h`, `--help` | |Show this help. | +|`--log` |`` |Path to log file | +|`--log-level` |`` |Log level (info, warning, error, critical) | +|`--log-format` |`` |Log format (plain, json-stream) | +|`--quiet` | |Suppress console output. | +|`--profile` | |Active project profile(s) | +## Commands + +|Command |Description | +|:-------|:--------------------------------------------| +|`help` |Show this help or the help of a sub-command. | + + +## Examples +### Render markdown to HTML + +``` {.bash filename='Terminal'} +quarto pandoc document.md --to html --output document.html +``` +## Examples +### List Pandoc output formats + +``` {.bash filename='Terminal'} +quarto pandoc --list-output-formats +``` + diff --git a/docs/cli/_preview.md b/docs/cli/_preview.md new file mode 100644 index 0000000000..ef9a68e60f --- /dev/null +++ b/docs/cli/_preview.md @@ -0,0 +1,92 @@ +Render and preview a document or website project. + +Automatically reloads the browser when input files or document resources (e.g. CSS) change. + +For website preview, the most recent execution results of computational documents are used to render +the site (this is to optimize startup time). If you want to perform a full render prior to +previewing pass the --render option with "all" or a comma-separated list of formats to render. + +For document preview, input file changes will result in a re-render (pass --no-watch to prevent). + +You can also include arbitrary command line arguments to be forwarded to quarto render. + +``` {.bash} +quarto preview [file:string] [...args:string] +``` + + +## Options + +|Flags |Arguments |Description | +|:-------------------|:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------| +|`-h`, `--help` | |Show this help. | +|`--port` |`[port:number]` |Suggested port to listen on (defaults to random value between 3000 and 8000). +If the port is not available then a random port between 3000 and 8000 will be selected. | +|`--host` |`[host:string]` |Hostname to bind to (defaults to 127.0.0.1) | +|`--render` |`[format:string]` |Render to the specified format(s) before previewing | +|`--no-serve` | |Don't run a local preview web server (just monitor and re-render input files) | +|`--no-navigate` | |Don't navigate the browser automatically when outputs are updated. | +|`--no-browser` | |Don't open a browser to preview the site. | +|`--no-watch-inputs` | |Do not re-render input files when they change. | +|`--timeout` | |Time (in seconds) after which to exit if there are no active clients. | +|`--log` |`` |Path to log file | +|`--log-level` |`` |Log level (info, warning, error, critical) | +|`--log-format` |`` |Log format (plain, json-stream) | +|`--quiet` | |Suppress console output. | +|`--profile` | |Active project profile(s) | +## Commands + +|Command |Description | +|:-------|:--------------------------------------------| +|`help` |Show this help or the help of a sub-command. | + + +## Examples +### Preview document + +``` {.bash filename='Terminal'} +quarto preview doc.qmd +``` +## Examples +### Preview document with render command line args + +``` {.bash filename='Terminal'} +quarto preview doc.qmd --toc +``` +## Examples +### Preview document (don't watch for input changes) + +``` {.bash filename='Terminal'} +quarto preview doc.qmd --no-watch-inputs +``` +## Examples +### Preview website with most recent execution results + +``` {.bash filename='Terminal'} +quarto preview +``` +## Examples +### Previewing website using a specific port + +``` {.bash filename='Terminal'} +quarto preview --port 4444 +``` +## Examples +### Preview website (don't open a browser) + +``` {.bash filename='Terminal'} +quarto preview --no-browser +``` +## Examples +### Fully render all website/book formats then preview + +``` {.bash filename='Terminal'} +quarto preview --render all +``` +## Examples +### Fully render the html format then preview + +``` {.bash filename='Terminal'} +quarto preview --render html +``` + diff --git a/docs/cli/_publish.md b/docs/cli/_publish.md new file mode 100644 index 0000000000..e1676524b3 --- /dev/null +++ b/docs/cli/_publish.md @@ -0,0 +1,122 @@ +Publish a document or project to a provider. + +Available providers include: + + - Quarto Pub (quarto-pub) + - GitHub Pages (gh-pages) + - Posit Connect (connect) + - Posit Cloud (posit-cloud) + - Netlify (netlify) + - Confluence (confluence) + - Hugging Face Spaces (huggingface) + +Accounts are configured interactively during publishing. +Manage/remove accounts with: quarto publish accounts + +``` {.bash} +quarto publish [provider] [path] +``` + + +## Options + +|Flags |Arguments |Description | +|:--------------|:-----------------|:--------------------------------------------------| +|`-h`, `--help` | |Show this help. | +|`--id` |`` |Identifier of content to publish | +|`--server` |`` |Server to publish to | +|`--token` |`` |Access token for publising provider | +|`--no-render` | |Do not render before publishing. | +|`--no-prompt` | |Do not prompt to confirm publishing destination | +|`--no-browser` | |Do not open a browser to the site after publishing | +|`--log` |`` |Path to log file | +|`--log-level` |`` |Log level (info, warning, error, critical) | +|`--log-format` |`` |Log format (plain, json-stream) | +|`--quiet` | |Suppress console output. | +|`--profile` | |Active project profile(s) | +## Commands + +|Command |Description | +|:-------|:--------------------------------------------| +|`help` |Show this help or the help of a sub-command. | + + +## Examples +### Publish project (prompt for provider) + +``` {.bash filename='Terminal'} +quarto publish +``` +## Examples +### Publish document (prompt for provider) + +``` {.bash filename='Terminal'} +quarto publish document.qmd +``` +## Examples +### Publish project to Hugging Face Spaces + +``` {.bash filename='Terminal'} +quarto publish huggingface +``` +## Examples +### Publish project to Netlify + +``` {.bash filename='Terminal'} +quarto publish netlify +``` +## Examples +### Publish with explicit target + +``` {.bash filename='Terminal'} +quarto publish netlify --id DA36416-F950-4647-815C-01A24233E294 +``` +## Examples +### Publish project to GitHub Pages + +``` {.bash filename='Terminal'} +quarto publish gh-pages +``` +## Examples +### Publish project to Posit Connect + +``` {.bash filename='Terminal'} +quarto publish connect +``` +## Examples +### Publish with explicit credentials + +``` {.bash filename='Terminal'} +quarto publish connect --server example.com --token 01A24233E294 +``` +## Examples +### Publish project to Posit Cloud + +``` {.bash filename='Terminal'} +quarto publish posit-cloud +``` +## Examples +### Publish without confirmation prompt + +``` {.bash filename='Terminal'} +quarto publish --no-prompt +``` +## Examples +### Publish without rendering + +``` {.bash filename='Terminal'} +quarto publish --no-render +``` +## Examples +### Publish without opening browser + +``` {.bash filename='Terminal'} +quarto publish --no-browser +``` +## Examples +### Manage/remove publishing accounts + +``` {.bash filename='Terminal'} +quarto publish accounts +``` + diff --git a/docs/cli/_remove.md b/docs/cli/_remove.md new file mode 100644 index 0000000000..48250f2fe8 --- /dev/null +++ b/docs/cli/_remove.md @@ -0,0 +1,33 @@ +Removes an extension. + +``` {.bash} +quarto remove [target...] +``` + + +## Options + +|Flags |Arguments |Description | +|:--------------|:---------------|:-------------------------------------------------------------------------------------| +|`-h`, `--help` | |Show this help. | +|`--no-prompt` | |Do not prompt to confirm actions | +|`--embed` |`` |Remove this extension from within another extension (used when authoring extensions). | +|`--log` |`` |Path to log file | +|`--log-level` |`` |Log level (info, warning, error, critical) | +|`--log-format` |`` |Log format (plain, json-stream) | +|`--quiet` | |Suppress console output. | +|`--profile` | |Active project profile(s) | +## Commands + +|Command |Description | +|:-------|:--------------------------------------------| +|`help` |Show this help or the help of a sub-command. | + + +## Examples +### Remove extension using name + +``` {.bash filename='Terminal'} +quarto remove +``` + diff --git a/docs/cli/_render.md b/docs/cli/_render.md new file mode 100644 index 0000000000..ed24366fc0 --- /dev/null +++ b/docs/cli/_render.md @@ -0,0 +1,79 @@ +Render files or projects to various document types. + +``` {.bash} +quarto render [input:string] [...args] +``` + + +## Options + +|Flags |Arguments |Description | +|:--------------------------|:----------|:----------------------------------------------------------------| +|`-h`, `--help` | |Show this help. | +|`-t`, `--to` | |Specify output format(s). | +|`-o`, `--output` | |Write output to FILE (use '--output -' for stdout). | +|`--output-dir` | |Write output to DIR (path is input/project relative) | +|`-M`, `--metadata` | |Metadata value (KEY:VALUE). | +|`--site-url` | |Override site-url for website or book output | +|`--execute` | |Execute code (--no-execute to skip execution). | +|`-P`, `--execute-param` | |Execution parameter (KEY:VALUE). | +|`--execute-params` | |YAML file with execution parameters. | +|`--execute-dir` | |Working directory for code execution. | +|`--execute-daemon` | |Keep Jupyter kernel alive (defaults to 300 seconds). | +|`--execute-daemon-restart` | |Restart keepalive Jupyter kernel before render. | +|`--execute-debug` | |Show debug output when executing computations. | +|`--use-freezer` | |Force use of frozen computations for an incremental file render. | +|`--cache` | |Cache execution output (--no-cache to prevent cache). | +|`--cache-refresh` | |Force refresh of execution cache. | +|`--no-clean` | |Do not clean project output-dir prior to render | +|`--debug` | |Leave intermediate files in place after render. | +|`pandoc-args...` | |Additional pandoc command line arguments. | +|`--log` |`` |Path to log file | +|`--log-level` |`` |Log level (info, warning, error, critical) | +|`--log-format` |`` |Log format (plain, json-stream) | +|`--quiet` | |Suppress console output. | +|`--profile` | |Active project profile(s) | +## Commands + +|Command |Description | +|:-------|:--------------------------------------------| +|`help` |Show this help or the help of a sub-command. | + + +## Examples +### Render Markdown + +``` {.bash filename='Terminal'} +quarto render document.qmd +quarto render document.qmd --to html +quarto render document.qmd --to pdf --toc +``` +## Examples +### Render Notebook + +``` {.bash filename='Terminal'} +quarto render notebook.ipynb +quarto render notebook.ipynb --to docx +quarto render notebook.ipynb --to pdf --toc +``` +## Examples +### Render Project + +``` {.bash filename='Terminal'} +quarto render +quarto render projdir +``` +## Examples +### Render w/ Metadata + +``` {.bash filename='Terminal'} +quarto render document.qmd -M echo:false +quarto render document.qmd -M code-fold:true +``` +## Examples +### Render to Stdout + +``` {.bash filename='Terminal'} +quarto render document.qmd --output - +``` + diff --git a/docs/cli/_run.md b/docs/cli/_run.md new file mode 100644 index 0000000000..98c193c956 --- /dev/null +++ b/docs/cli/_run.md @@ -0,0 +1,28 @@ +Run a TypeScript, R, Python, or Lua script. + +Run a utility script written in a variety of languages. For details, see: +https://quarto.org/docs/projects/scripts.html#periodic-scripts + +``` {.bash} +quarto run [script:string] [...args] +``` + + +## Options + +|Flags |Arguments |Description | +|:--------------|:----------|:------------------------------------------| +|`-h`, `--help` | |Show this help. | +|`--log` |`` |Path to log file | +|`--log-level` |`` |Log level (info, warning, error, critical) | +|`--log-format` |`` |Log format (plain, json-stream) | +|`--quiet` | |Suppress console output. | +|`--profile` | |Active project profile(s) | +## Commands + +|Command |Description | +|:-------|:--------------------------------------------| +|`help` |Show this help or the help of a sub-command. | + + + diff --git a/docs/cli/_serve.md b/docs/cli/_serve.md new file mode 100644 index 0000000000..a6910e0e37 --- /dev/null +++ b/docs/cli/_serve.md @@ -0,0 +1,43 @@ +Serve a Shiny interactive document. + +By default, the document will be rendered first and then served. If you have previously rendered the document, pass --no-render to skip the rendering step. + +``` {.bash} +quarto serve [input:string] +``` + + +## Options + +|Flags |Arguments |Description | +|:--------------|:---------------|:---------------------------------------------------| +|`-h`, `--help` | |Show this help. | +|`--no-render` | |Do not render the document before serving. | +|`-p`, `--port` |`[port:number]` |The TCP port that the application should listen on. | +|`--host` |`[host:string]` |Hostname to bind to (defaults to 127.0.0.1) | +|`--browser` | |Open a browser to preview the site. | +|`--log` |`` |Path to log file | +|`--log-level` |`` |Log level (info, warning, error, critical) | +|`--log-format` |`` |Log format (plain, json-stream) | +|`--quiet` | |Suppress console output. | +|`--profile` | |Active project profile(s) | +## Commands + +|Command |Description | +|:-------|:--------------------------------------------| +|`help` |Show this help or the help of a sub-command. | + + +## Examples +### Serve an interactive Shiny document + +``` {.bash filename='Terminal'} +quarto serve dashboard.qmd +``` +## Examples +### Serve a document without rendering + +``` {.bash filename='Terminal'} +quarto serve dashboard.qmd --no-render +``` + diff --git a/docs/cli/_tools.md b/docs/cli/_tools.md new file mode 100644 index 0000000000..684ca284dd --- /dev/null +++ b/docs/cli/_tools.md @@ -0,0 +1,26 @@ +Display the status of Quarto installed dependencies + +``` {.bash} +quarto tools +``` + + +## Options + +|Flags |Arguments |Description | +|:--------------|:---------|:---------------| +|`-h`, `--help` | |Show this help. | +## Commands + +|Command |Description | +|:-------|:--------------------------------------------| +|`help` |Show this help or the help of a sub-command. | + + +## Examples +### Show tool status + +``` {.bash filename='Terminal'} +quarto tools +``` + diff --git a/docs/cli/_typst.md b/docs/cli/_typst.md new file mode 100644 index 0000000000..eaaf1e6c14 --- /dev/null +++ b/docs/cli/_typst.md @@ -0,0 +1,40 @@ +Run the version of Typst embedded within Quarto. + +You can pass arbitrary command line arguments to quarto typst (they will +be passed through unmodified to Typst) + +``` {.bash} +quarto typst [...args] +``` + + +## Options + +|Flags |Arguments |Description | +|:--------------|:----------|:------------------------------------------| +|`-h`, `--help` | |Show this help. | +|`--log` |`` |Path to log file | +|`--log-level` |`` |Log level (info, warning, error, critical) | +|`--log-format` |`` |Log format (plain, json-stream) | +|`--quiet` | |Suppress console output. | +|`--profile` | |Active project profile(s) | +## Commands + +|Command |Description | +|:-------|:--------------------------------------------| +|`help` |Show this help or the help of a sub-command. | + + +## Examples +### Compile Typst to PDF + +``` {.bash filename='Terminal'} +quarto typst compile document.typ +``` +## Examples +### List all discovered fonts in system and custom font paths + +``` {.bash filename='Terminal'} +quarto typst fonts +``` + diff --git a/docs/cli/_uninstall.md b/docs/cli/_uninstall.md new file mode 100644 index 0000000000..922301fbfe --- /dev/null +++ b/docs/cli/_uninstall.md @@ -0,0 +1,33 @@ +Removes an extension. + +``` {.bash} +quarto uninstall [tool] +``` + + +## Options + +|Flags |Arguments |Description | +|:---------------|:----------|:-------------------------------------------| +|`-h`, `--help` | |Show this help. | +|`--no-prompt` | |Do not prompt to confirm actions | +|`--update-path` | |Update system path when a tool is installed | +|`--log` |`` |Path to log file | +|`--log-level` |`` |Log level (info, warning, error, critical) | +|`--log-format` |`` |Log format (plain, json-stream) | +|`--quiet` | |Suppress console output. | +|`--profile` | |Active project profile(s) | +## Commands + +|Command |Description | +|:-------|:--------------------------------------------| +|`help` |Show this help or the help of a sub-command. | + + +## Examples +### Remove extension using name + +``` {.bash filename='Terminal'} +quarto remove +``` + diff --git a/docs/cli/_update.md b/docs/cli/_update.md new file mode 100644 index 0000000000..7350b0b34e --- /dev/null +++ b/docs/cli/_update.md @@ -0,0 +1,63 @@ +Updates an extension or global dependency. + +``` {.bash} +quarto update [target...] +``` + + +## Options + +|Flags |Arguments |Description | +|:--------------|:---------------|:-------------------------------------------------------------------------------| +|`-h`, `--help` | |Show this help. | +|`--no-prompt` | |Do not prompt to confirm actions | +|`--embed` |`` |Embed this extension within another extension (used when authoring extensions). | +|`--log` |`` |Path to log file | +|`--log-level` |`` |Log level (info, warning, error, critical) | +|`--log-format` |`` |Log format (plain, json-stream) | +|`--quiet` | |Suppress console output. | +|`--profile` | |Active project profile(s) | +## Commands + +|Command |Description | +|:-------|:--------------------------------------------| +|`help` |Show this help or the help of a sub-command. | + + +## Examples +### Update extension (Github) + +``` {.bash filename='Terminal'} +quarto update extension / +``` +## Examples +### Update extension (file) + +``` {.bash filename='Terminal'} +quarto update extension +``` +## Examples +### Update extension (url) + +``` {.bash filename='Terminal'} +quarto update extension +``` +## Examples +### Update TinyTeX + +``` {.bash filename='Terminal'} +quarto update tool tinytex +``` +## Examples +### Update Chromium + +``` {.bash filename='Terminal'} +quarto update tool chromium +``` +## Examples +### Choose tool to update + +``` {.bash filename='Terminal'} +quarto update tool +``` + diff --git a/docs/cli/_use.md b/docs/cli/_use.md new file mode 100644 index 0000000000..105de289ab --- /dev/null +++ b/docs/cli/_use.md @@ -0,0 +1,21 @@ +Automate document or project setup tasks. + +``` {.bash} +quarto use [target:string] +``` + + +## Options + +|Flags |Arguments |Description | +|:-------------|:---------|:--------------------------------| +|`--no-prompt` | |Do not prompt to confirm actions | +## Commands + +|Command |Description | +|:----------|:----------------------------------------------------| +|`template` |Use a Quarto template for this directory or project. | +|`binder` |Configure the current project with Binder support. | + + + diff --git a/docs/cli/add.qmd b/docs/cli/add.qmd index 9ed4399c95..6ec5b3f933 100644 --- a/docs/cli/add.qmd +++ b/docs/cli/add.qmd @@ -1,3 +1,6 @@ --- -title: add +title: 'add' --- + +{{< include _add.md >}} + diff --git a/docs/cli/call.qmd b/docs/cli/call.qmd index 8eadd376f4..b6184632c3 100644 --- a/docs/cli/call.qmd +++ b/docs/cli/call.qmd @@ -1,3 +1,6 @@ --- -title: call +title: 'call' --- + +{{< include _call.md >}} + diff --git a/docs/cli/capabilities.qmd b/docs/cli/capabilities.qmd index a3b119603c..13a928549e 100644 --- a/docs/cli/capabilities.qmd +++ b/docs/cli/capabilities.qmd @@ -1,3 +1,6 @@ --- -title: capabilities +title: 'capabilities' --- + +{{< include _capabilities.md >}} + diff --git a/docs/cli/check.qmd b/docs/cli/check.qmd index a21ebbfc3a..04da4aef58 100644 --- a/docs/cli/check.qmd +++ b/docs/cli/check.qmd @@ -1,3 +1,6 @@ --- -title: check +title: 'check' --- + +{{< include _check.md >}} + diff --git a/docs/cli/convert.qmd b/docs/cli/convert.qmd index 7138a6907c..f6de721d99 100644 --- a/docs/cli/convert.qmd +++ b/docs/cli/convert.qmd @@ -1,3 +1,6 @@ --- -title: convert +title: 'convert' --- + +{{< include _convert.md >}} + diff --git a/docs/cli/create-project.qmd b/docs/cli/create-project.qmd index ca9ea91019..7c382fda94 100644 --- a/docs/cli/create-project.qmd +++ b/docs/cli/create-project.qmd @@ -1,3 +1,6 @@ --- -title: create-project +title: 'create-project' --- + +{{< include _create-project.md >}} + diff --git a/docs/cli/create.qmd b/docs/cli/create.qmd index 26cb6196fb..0aa0f96b53 100644 --- a/docs/cli/create.qmd +++ b/docs/cli/create.qmd @@ -1,3 +1,6 @@ --- -title: create +title: 'create' --- + +{{< include _create.md >}} + diff --git a/docs/cli/dev-call.qmd b/docs/cli/dev-call.qmd index 82d3e106ea..ed7efac2c6 100644 --- a/docs/cli/dev-call.qmd +++ b/docs/cli/dev-call.qmd @@ -1,3 +1,6 @@ --- -title: dev-call +title: 'dev-call' --- + +{{< include _dev-call.md >}} + diff --git a/docs/cli/editor-support.qmd b/docs/cli/editor-support.qmd index 65069a2efd..6bdf8c7fc6 100644 --- a/docs/cli/editor-support.qmd +++ b/docs/cli/editor-support.qmd @@ -1,3 +1,6 @@ --- -title: editor-support +title: 'editor-support' --- + +{{< include _editor-support.md >}} + diff --git a/docs/cli/generate-md.R b/docs/cli/generate-md.R new file mode 100644 index 0000000000..d24e1539c4 --- /dev/null +++ b/docs/cli/generate-md.R @@ -0,0 +1,110 @@ +library(jsonlite) +library(knitr) +library(dplyr) +library(tidyr) + +heading <- function(text, level = 2) { + paste0(strrep("#", level), " ", text, "\n") +} + +process_usage <- function(name, usage) { + xfun::fenced_block( + paste("quarto", name, usage, sep = " "), + attrs = ".bash" + ) |> + paste(collapse = "\n") +} + +process_options <- function(options) { + tibble(options = options) |> + unnest_wider(options) |> + select(flags, typeDefinition, description) |> + rowwise() |> + mutate( + flags = paste0("`", flags, "`", collapse = ", "), + typeDefinition = ifelse( + typeDefinition == "", + "", + paste0("`", typeDefinition, "`") + ) + ) |> + knitr::kable( + col.names = c("Flags", "Arguments", "Description"), + ) |> + paste(collapse = "\n") +} + +process_commands <- function(commands) { + tibble(commands = commands) |> + unnest_wider(commands) |> + mutate(name = paste0("`", name, "`")) |> + select(name, description) |> + knitr::kable( + col.names = c("Command", "Description"), + ) |> + paste(collapse = "\n") +} + +process_examples <- function(examples) { + if (length(examples) == 0) { + return("") + } + example_text <- examples |> + tibble() |> + unnest_wider(examples) |> + rowwise() |> + mutate( + description = xfun::fenced_block( + description, + attrs = c(".bash", "filename='Terminal'") + ) |> + paste(collapse = "\n") |> + paste0("\n"), + name = heading(name, 3), + text = paste0(name, description) + ) |> + pull(text) + paste0(heading("Examples", 2), example_text, collapse = "") +} + +md_content <- function(name, description, usage, options, commands, examples) { + usage_text <- process_usage(name, usage) + options_table <- process_options(options) + commands_table <- process_commands(commands) + examples_text <- process_examples(examples) + + paste( + description, + usage_text, + "\n", + heading("Options"), + options_table, + heading("Commands"), + commands_table, + "\n", + examples_text, + sep = "\n", + collapse = "\n" + ) +} + +cli_json <- read_json("cli-info.json") +commands <- cli_json$commands + +commands_content <- tibble(commands) |> + unnest_wider(commands) |> + rowwise() |> + mutate( + filename = paste0("_", name, ".md"), + content = md_content( + name, + description, + usage, + options, + commands, + examples + ) + ) + +commands_content |> + group_walk(~ with(.x, writeLines(content, filename))) diff --git a/docs/cli/inspect.qmd b/docs/cli/inspect.qmd index 8c1b8ffff1..1c40fc23d3 100644 --- a/docs/cli/inspect.qmd +++ b/docs/cli/inspect.qmd @@ -1,3 +1,6 @@ --- -title: inspect +title: 'inspect' --- + +{{< include _inspect.md >}} + diff --git a/docs/cli/install.qmd b/docs/cli/install.qmd index fb396b31b8..707b550235 100644 --- a/docs/cli/install.qmd +++ b/docs/cli/install.qmd @@ -1,3 +1,6 @@ --- -title: install +title: 'install' --- + +{{< include _install.md >}} + diff --git a/docs/cli/list.qmd b/docs/cli/list.qmd index 70224fe8ec..6ee6f5e676 100644 --- a/docs/cli/list.qmd +++ b/docs/cli/list.qmd @@ -1,3 +1,6 @@ --- -title: list +title: 'list' --- + +{{< include _list.md >}} + diff --git a/docs/cli/pandoc.qmd b/docs/cli/pandoc.qmd index 6e15ea0df0..20db3abe0d 100644 --- a/docs/cli/pandoc.qmd +++ b/docs/cli/pandoc.qmd @@ -1,3 +1,6 @@ --- -title: pandoc +title: 'pandoc' --- + +{{< include _pandoc.md >}} + diff --git a/docs/cli/preview.qmd b/docs/cli/preview.qmd index 1c2357416e..e02b58a78f 100644 --- a/docs/cli/preview.qmd +++ b/docs/cli/preview.qmd @@ -1,3 +1,6 @@ --- -title: preview +title: 'preview' --- + +{{< include _preview.md >}} + diff --git a/docs/cli/publish.qmd b/docs/cli/publish.qmd index b9d54a1dfa..3681b8055c 100644 --- a/docs/cli/publish.qmd +++ b/docs/cli/publish.qmd @@ -1,3 +1,6 @@ --- -title: publish +title: 'publish' --- + +{{< include _publish.md >}} + diff --git a/docs/cli/remove.qmd b/docs/cli/remove.qmd index 36b34a89cf..09f5dffe11 100644 --- a/docs/cli/remove.qmd +++ b/docs/cli/remove.qmd @@ -1,3 +1,6 @@ --- -title: remove +title: 'remove' --- + +{{< include _remove.md >}} + diff --git a/docs/cli/render.qmd b/docs/cli/render.qmd index 1a5d4f2d0a..e23c7de2d6 100644 --- a/docs/cli/render.qmd +++ b/docs/cli/render.qmd @@ -1,3 +1,6 @@ --- -title: render +title: 'render' --- + +{{< include _render.md >}} + diff --git a/docs/cli/run.qmd b/docs/cli/run.qmd index d07d135aad..4a26a3728c 100644 --- a/docs/cli/run.qmd +++ b/docs/cli/run.qmd @@ -1,3 +1,6 @@ --- -title: run +title: 'run' --- + +{{< include _run.md >}} + diff --git a/docs/cli/serve.qmd b/docs/cli/serve.qmd index 0b370f2728..f56919f9fa 100644 --- a/docs/cli/serve.qmd +++ b/docs/cli/serve.qmd @@ -1,3 +1,6 @@ --- -title: serve +title: 'serve' --- + +{{< include _serve.md >}} + diff --git a/docs/cli/tmp.md b/docs/cli/tmp.md new file mode 100644 index 0000000000..ed24366fc0 --- /dev/null +++ b/docs/cli/tmp.md @@ -0,0 +1,79 @@ +Render files or projects to various document types. + +``` {.bash} +quarto render [input:string] [...args] +``` + + +## Options + +|Flags |Arguments |Description | +|:--------------------------|:----------|:----------------------------------------------------------------| +|`-h`, `--help` | |Show this help. | +|`-t`, `--to` | |Specify output format(s). | +|`-o`, `--output` | |Write output to FILE (use '--output -' for stdout). | +|`--output-dir` | |Write output to DIR (path is input/project relative) | +|`-M`, `--metadata` | |Metadata value (KEY:VALUE). | +|`--site-url` | |Override site-url for website or book output | +|`--execute` | |Execute code (--no-execute to skip execution). | +|`-P`, `--execute-param` | |Execution parameter (KEY:VALUE). | +|`--execute-params` | |YAML file with execution parameters. | +|`--execute-dir` | |Working directory for code execution. | +|`--execute-daemon` | |Keep Jupyter kernel alive (defaults to 300 seconds). | +|`--execute-daemon-restart` | |Restart keepalive Jupyter kernel before render. | +|`--execute-debug` | |Show debug output when executing computations. | +|`--use-freezer` | |Force use of frozen computations for an incremental file render. | +|`--cache` | |Cache execution output (--no-cache to prevent cache). | +|`--cache-refresh` | |Force refresh of execution cache. | +|`--no-clean` | |Do not clean project output-dir prior to render | +|`--debug` | |Leave intermediate files in place after render. | +|`pandoc-args...` | |Additional pandoc command line arguments. | +|`--log` |`` |Path to log file | +|`--log-level` |`` |Log level (info, warning, error, critical) | +|`--log-format` |`` |Log format (plain, json-stream) | +|`--quiet` | |Suppress console output. | +|`--profile` | |Active project profile(s) | +## Commands + +|Command |Description | +|:-------|:--------------------------------------------| +|`help` |Show this help or the help of a sub-command. | + + +## Examples +### Render Markdown + +``` {.bash filename='Terminal'} +quarto render document.qmd +quarto render document.qmd --to html +quarto render document.qmd --to pdf --toc +``` +## Examples +### Render Notebook + +``` {.bash filename='Terminal'} +quarto render notebook.ipynb +quarto render notebook.ipynb --to docx +quarto render notebook.ipynb --to pdf --toc +``` +## Examples +### Render Project + +``` {.bash filename='Terminal'} +quarto render +quarto render projdir +``` +## Examples +### Render w/ Metadata + +``` {.bash filename='Terminal'} +quarto render document.qmd -M echo:false +quarto render document.qmd -M code-fold:true +``` +## Examples +### Render to Stdout + +``` {.bash filename='Terminal'} +quarto render document.qmd --output - +``` + diff --git a/docs/cli/tools.qmd b/docs/cli/tools.qmd index ba9e2b5f3a..473dd04b6e 100644 --- a/docs/cli/tools.qmd +++ b/docs/cli/tools.qmd @@ -1,3 +1,6 @@ --- -title: tools +title: 'tools' --- + +{{< include _tools.md >}} + diff --git a/docs/cli/typst.qmd b/docs/cli/typst.qmd index 8faaa047d6..1da45965dd 100644 --- a/docs/cli/typst.qmd +++ b/docs/cli/typst.qmd @@ -1,3 +1,6 @@ --- -title: typst +title: 'typst' --- + +{{< include _typst.md >}} + diff --git a/docs/cli/uninstall.qmd b/docs/cli/uninstall.qmd index 3ad0e2e15e..b9c52febb3 100644 --- a/docs/cli/uninstall.qmd +++ b/docs/cli/uninstall.qmd @@ -1,3 +1,6 @@ --- -title: uninstall +title: 'uninstall' --- + +{{< include _uninstall.md >}} + diff --git a/docs/cli/update.qmd b/docs/cli/update.qmd index 8cef1e90c1..8a0a9ed534 100644 --- a/docs/cli/update.qmd +++ b/docs/cli/update.qmd @@ -1,3 +1,6 @@ --- -title: update +title: 'update' --- + +{{< include _update.md >}} + diff --git a/docs/cli/use.qmd b/docs/cli/use.qmd index cce5dca17f..0d4ace9a3b 100644 --- a/docs/cli/use.qmd +++ b/docs/cli/use.qmd @@ -1,3 +1,6 @@ --- -title: use +title: 'use' --- + +{{< include _use.md >}} + From adaea6a805d20a38d80daecf7cd0863a39f88185 Mon Sep 17 00:00:00 2001 From: Charlotte Wickham Date: Thu, 8 May 2025 12:30:28 -0700 Subject: [PATCH 04/18] Rr-reorganize --- docs/cli/_create-project.md | 105 ------------------ docs/cli/_editor-support.md | 21 ---- docs/cli/add.qmd | 2 +- docs/cli/call.qmd | 7 +- docs/cli/capabilities.qmd | 2 +- docs/cli/check.qmd | 2 +- docs/cli/convert.qmd | 2 +- docs/cli/create-project.qmd | 6 - docs/cli/create.qmd | 2 +- docs/cli/dev-call.qmd | 2 +- docs/cli/editor-support.qmd | 6 - docs/cli/{ => includes}/_add.md | 6 +- docs/cli/includes/_call-engine.md | 28 +++++ docs/cli/{ => includes}/_call.md | 2 + docs/cli/{ => includes}/_capabilities.md | 2 + docs/cli/{ => includes}/_check.md | 8 +- docs/cli/{ => includes}/_convert.md | 6 +- docs/cli/{ => includes}/_create.md | 2 + docs/cli/includes/_dev-call-cli-info.md | 26 +++++ docs/cli/{ => includes}/_dev-call.md | 2 + docs/cli/{ => includes}/_inspect.md | 8 +- docs/cli/{ => includes}/_install.md | 6 +- docs/cli/{ => includes}/_list.md | 4 +- docs/cli/{ => includes}/_pandoc.md | 4 +- docs/cli/{ => includes}/_preview.md | 16 +-- docs/cli/{ => includes}/_publish.md | 26 +++-- docs/cli/{ => includes}/_remove.md | 2 + docs/cli/{ => includes}/_render.md | 10 +- docs/cli/{ => includes}/_run.md | 2 + docs/cli/{ => includes}/_serve.md | 4 +- docs/cli/{ => includes}/_tools.md | 2 + docs/cli/{ => includes}/_typst.md | 4 +- docs/cli/{ => includes}/_uninstall.md | 2 + docs/cli/{ => includes}/_update.md | 12 +- docs/cli/includes/_use-binder.md | 29 +++++ docs/cli/includes/_use-template.md | 28 +++++ docs/cli/{ => includes}/_use.md | 2 + docs/cli/inspect.qmd | 2 +- docs/cli/install.qmd | 2 +- docs/cli/list.qmd | 2 +- docs/cli/pandoc.qmd | 2 +- docs/cli/preview.qmd | 2 +- docs/cli/publish.qmd | 2 +- docs/cli/remove.qmd | 2 +- docs/cli/render.qmd | 2 +- docs/cli/run.qmd | 2 +- docs/cli/serve.qmd | 2 +- docs/cli/tmp.md | 79 ------------- docs/cli/tools.qmd | 2 +- docs/cli/typst.qmd | 2 +- docs/cli/uninstall.qmd | 2 +- docs/cli/update.qmd | 2 +- docs/cli/use.qmd | 8 +- .../reference-cli-generate-md.R | 52 +++++++-- 54 files changed, 277 insertions(+), 290 deletions(-) delete mode 100644 docs/cli/_create-project.md delete mode 100644 docs/cli/_editor-support.md delete mode 100644 docs/cli/create-project.qmd delete mode 100644 docs/cli/editor-support.qmd rename docs/cli/{ => includes}/_add.md (98%) create mode 100644 docs/cli/includes/_call-engine.md rename docs/cli/{ => includes}/_call.md (99%) rename docs/cli/{ => includes}/_capabilities.md (99%) rename docs/cli/{ => includes}/_check.md (97%) rename docs/cli/{ => includes}/_convert.md (98%) rename docs/cli/{ => includes}/_create.md (99%) create mode 100644 docs/cli/includes/_dev-call-cli-info.md rename docs/cli/{ => includes}/_dev-call.md (99%) rename docs/cli/{ => includes}/_inspect.md (97%) rename docs/cli/{ => includes}/_install.md (98%) rename docs/cli/{ => includes}/_list.md (98%) rename docs/cli/{ => includes}/_pandoc.md (99%) rename docs/cli/{ => includes}/_preview.md (98%) rename docs/cli/{ => includes}/_publish.md (95%) rename docs/cli/{ => includes}/_remove.md (99%) rename docs/cli/{ => includes}/_render.md (98%) rename docs/cli/{ => includes}/_run.md (99%) rename docs/cli/{ => includes}/_serve.md (99%) rename docs/cli/{ => includes}/_tools.md (99%) rename docs/cli/{ => includes}/_typst.md (99%) rename docs/cli/{ => includes}/_uninstall.md (99%) rename docs/cli/{ => includes}/_update.md (97%) create mode 100644 docs/cli/includes/_use-binder.md create mode 100644 docs/cli/includes/_use-template.md rename docs/cli/{ => includes}/_use.md (99%) delete mode 100644 docs/cli/tmp.md rename docs/cli/generate-md.R => tools/reference-cli-generate-md.R (63%) diff --git a/docs/cli/_create-project.md b/docs/cli/_create-project.md deleted file mode 100644 index f2a09bd0d8..0000000000 --- a/docs/cli/_create-project.md +++ /dev/null @@ -1,105 +0,0 @@ -Create a project for rendering multiple documents - -``` {.bash} -quarto create-project [dir:string] -``` - - -## Options - -|Flags |Arguments |Description | -|:-----------------|:-------------------|:-----------------------------------------------------------------------------------------| -|`-h`, `--help` | |Show this help. | -|`--title` |`` |Project title | -|`--type` |`` |Project type (book, default, website, manuscript) | -|`--template` |`` |Use a specific project template | -|`--engine` |`` |Use execution engine ([object Object], [object Object], [object Object], [object Object]) | -|`--editor` |`` |Default editor for project ('source' or 'visual') | -|`--with-venv` |`[packages:string]` |Create a virtualenv for this project | -|`--with-condaenv` |`[packages:string]` |Create a condaenv for this project | -|`--no-scaffold` | |Don't create initial project file(s) | -|`--log` |`` |Path to log file | -|`--log-level` |`` |Log level (info, warning, error, critical) | -|`--log-format` |`` |Log format (plain, json-stream) | -|`--quiet` | |Suppress console output. | -|`--profile` | |Active project profile(s) | -## Commands - -|Command |Description | -|:-------|:--------------------------------------------| -|`help` |Show this help or the help of a sub-command. | - - -## Examples -### Create a project in the current directory - -``` {.bash filename='Terminal'} -quarto create-project -``` -## Examples -### Create a project in the 'myproject' directory - -``` {.bash filename='Terminal'} -quarto create-project myproject -``` -## Examples -### Create a website project - -``` {.bash filename='Terminal'} -quarto create-project mysite --type website -``` -## Examples -### Create a blog project - -``` {.bash filename='Terminal'} -quarto create-project mysite --type website --template blog -``` -## Examples -### Create a book project - -``` {.bash filename='Terminal'} -quarto create-project mybook --type book -``` -## Examples -### Create a website project with jupyter - -``` {.bash filename='Terminal'} -quarto create-project mysite --type website --engine jupyter -``` -## Examples -### Create a website project with jupyter + kernel - -``` {.bash filename='Terminal'} -quarto create-project mysite --type website --engine jupyter:python3 -``` -## Examples -### Create a book project with knitr - -``` {.bash filename='Terminal'} -quarto create-project mybook --type book --engine knitr -``` -## Examples -### Create jupyter project with virtualenv - -``` {.bash filename='Terminal'} -quarto create-project myproject --engine jupyter --with-venv -``` -## Examples -### Create jupyter project with virtualenv + packages - -``` {.bash filename='Terminal'} -quarto create-project myproject --engine jupyter --with-venv pandas,matplotlib -``` -## Examples -### Create jupyter project with condaenv - -``` {.bash filename='Terminal'} -quarto create-project myproject --engine jupyter --with-condaenv -``` -## Examples -### Create jupyter project with condaenv + packages - -``` {.bash filename='Terminal'} -quarto create-project myproject --engine jupyter --with-condaenv pandas,matplotlib -``` - diff --git a/docs/cli/_editor-support.md b/docs/cli/_editor-support.md deleted file mode 100644 index e9b2471bef..0000000000 --- a/docs/cli/_editor-support.md +++ /dev/null @@ -1,21 +0,0 @@ -Miscellaneous tools to support Quarto editor modes - -``` {.bash} -quarto editor-support -``` - - -## Options - -|Flags |Arguments |Description | -|:--------------|:---------|:---------------| -|`-h`, `--help` | |Show this help. | -## Commands - -|Command |Description | -|:----------|:--------------------------------------------| -|`help` |Show this help or the help of a sub-command. | -|`crossref` |Index cross references for content | - - - diff --git a/docs/cli/add.qmd b/docs/cli/add.qmd index 6ec5b3f933..eb2a629dc3 100644 --- a/docs/cli/add.qmd +++ b/docs/cli/add.qmd @@ -2,5 +2,5 @@ title: 'add' --- -{{< include _add.md >}} +{{< include includes/_add.md >}} diff --git a/docs/cli/call.qmd b/docs/cli/call.qmd index b6184632c3..37abad571f 100644 --- a/docs/cli/call.qmd +++ b/docs/cli/call.qmd @@ -1,6 +1,11 @@ --- title: 'call' +shift-heading-level-by: 1 --- -{{< include _call.md >}} +{{< include includes/_call.md >}} + +# call engine + +{{< include includes/_call-engine.md >}} diff --git a/docs/cli/capabilities.qmd b/docs/cli/capabilities.qmd index 13a928549e..16d18d8c2a 100644 --- a/docs/cli/capabilities.qmd +++ b/docs/cli/capabilities.qmd @@ -2,5 +2,5 @@ title: 'capabilities' --- -{{< include _capabilities.md >}} +{{< include includes/_capabilities.md >}} diff --git a/docs/cli/check.qmd b/docs/cli/check.qmd index 04da4aef58..5c5869fd89 100644 --- a/docs/cli/check.qmd +++ b/docs/cli/check.qmd @@ -2,5 +2,5 @@ title: 'check' --- -{{< include _check.md >}} +{{< include includes/_check.md >}} diff --git a/docs/cli/convert.qmd b/docs/cli/convert.qmd index f6de721d99..3473db59e4 100644 --- a/docs/cli/convert.qmd +++ b/docs/cli/convert.qmd @@ -2,5 +2,5 @@ title: 'convert' --- -{{< include _convert.md >}} +{{< include includes/_convert.md >}} diff --git a/docs/cli/create-project.qmd b/docs/cli/create-project.qmd deleted file mode 100644 index 7c382fda94..0000000000 --- a/docs/cli/create-project.qmd +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: 'create-project' ---- - -{{< include _create-project.md >}} - diff --git a/docs/cli/create.qmd b/docs/cli/create.qmd index 0aa0f96b53..2442da3cca 100644 --- a/docs/cli/create.qmd +++ b/docs/cli/create.qmd @@ -2,5 +2,5 @@ title: 'create' --- -{{< include _create.md >}} +{{< include includes/_create.md >}} diff --git a/docs/cli/dev-call.qmd b/docs/cli/dev-call.qmd index ed7efac2c6..16d2ee1f21 100644 --- a/docs/cli/dev-call.qmd +++ b/docs/cli/dev-call.qmd @@ -2,5 +2,5 @@ title: 'dev-call' --- -{{< include _dev-call.md >}} +{{< include includes/_dev-call.md >}} diff --git a/docs/cli/editor-support.qmd b/docs/cli/editor-support.qmd deleted file mode 100644 index 6bdf8c7fc6..0000000000 --- a/docs/cli/editor-support.qmd +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: 'editor-support' ---- - -{{< include _editor-support.md >}} - diff --git a/docs/cli/_add.md b/docs/cli/includes/_add.md similarity index 98% rename from docs/cli/_add.md rename to docs/cli/includes/_add.md index 6cc0e9e913..abd200d799 100644 --- a/docs/cli/_add.md +++ b/docs/cli/includes/_add.md @@ -17,6 +17,8 @@ quarto add |`--log-format` |`` |Log format (plain, json-stream) | |`--quiet` | |Suppress console output. | |`--profile` | |Active project profile(s) | + + ## Commands |Command |Description | @@ -30,13 +32,13 @@ quarto add ``` {.bash filename='Terminal'} quarto add / ``` -## Examples + ### Install extension (file) ``` {.bash filename='Terminal'} quarto add ``` -## Examples + ### Install extension (url) ``` {.bash filename='Terminal'} diff --git a/docs/cli/includes/_call-engine.md b/docs/cli/includes/_call-engine.md new file mode 100644 index 0000000000..bf290ef1f0 --- /dev/null +++ b/docs/cli/includes/_call-engine.md @@ -0,0 +1,28 @@ +Access functionality specific to quarto's different rendering engines. + +``` {.bash} +quarto call engine +``` + + +## Options + +|Flags |Arguments |Description | +|:--------------|:----------|:------------------------------------------| +|`-h`, `--help` | |Show this help. | +|`--log` |`` |Path to log file | +|`--log-level` |`` |Log level (info, warning, error, critical) | +|`--log-format` |`` |Log format (plain, json-stream) | +|`--quiet` | |Suppress console output. | +|`--profile` | |Active project profile(s) | + + +## Commands + +|Command |Description | +|:-------|:------------------------------------------------------------| +|`help` |Show this help or the help of a sub-command. | +|`julia` |Access functionality specific to the julia rendering engine. | + + + diff --git a/docs/cli/_call.md b/docs/cli/includes/_call.md similarity index 99% rename from docs/cli/_call.md rename to docs/cli/includes/_call.md index 9662e1be01..dd28a5dd42 100644 --- a/docs/cli/_call.md +++ b/docs/cli/includes/_call.md @@ -10,6 +10,8 @@ quarto call |Flags |Arguments |Description | |:--------------|:---------|:---------------| |`-h`, `--help` | |Show this help. | + + ## Commands |Command |Description | diff --git a/docs/cli/_capabilities.md b/docs/cli/includes/_capabilities.md similarity index 99% rename from docs/cli/_capabilities.md rename to docs/cli/includes/_capabilities.md index 4447c11262..a7603f179f 100644 --- a/docs/cli/_capabilities.md +++ b/docs/cli/includes/_capabilities.md @@ -15,6 +15,8 @@ quarto capabilities |`--log-format` |`` |Log format (plain, json-stream) | |`--quiet` | |Suppress console output. | |`--profile` | |Active project profile(s) | + + ## Commands |Command |Description | diff --git a/docs/cli/_check.md b/docs/cli/includes/_check.md similarity index 97% rename from docs/cli/_check.md rename to docs/cli/includes/_check.md index 5afa168d0e..ef69c0c2d4 100644 --- a/docs/cli/_check.md +++ b/docs/cli/includes/_check.md @@ -19,6 +19,8 @@ quarto check [target:string] |`--log-format` |`` |Log format (plain, json-stream) | |`--quiet` | |Suppress console output. | |`--profile` | |Active project profile(s) | + + ## Commands |Command |Description | @@ -32,19 +34,19 @@ quarto check [target:string] ``` {.bash filename='Terminal'} quarto check install ``` -## Examples + ### Check Jupyter engine ``` {.bash filename='Terminal'} quarto check jupyter ``` -## Examples + ### Check Knitr engine ``` {.bash filename='Terminal'} quarto check knitr ``` -## Examples + ### Check installation and all engines ``` {.bash filename='Terminal'} diff --git a/docs/cli/_convert.md b/docs/cli/includes/_convert.md similarity index 98% rename from docs/cli/_convert.md rename to docs/cli/includes/_convert.md index 65b11e9b48..0615e3d80a 100644 --- a/docs/cli/_convert.md +++ b/docs/cli/includes/_convert.md @@ -17,6 +17,8 @@ quarto convert |`--log-format` |`` |Log format (plain, json-stream) | |`--quiet` | |Suppress console output. | |`--profile` | |Active project profile(s) | + + ## Commands |Command |Description | @@ -30,13 +32,13 @@ quarto convert ``` {.bash filename='Terminal'} quarto convert mydocument.ipynb ``` -## Examples + ### Convert markdown to notebook ``` {.bash filename='Terminal'} quarto convert mydocument.qmd ``` -## Examples + ### Convert notebook to markdown, writing to file ``` {.bash filename='Terminal'} diff --git a/docs/cli/_create.md b/docs/cli/includes/_create.md similarity index 99% rename from docs/cli/_create.md rename to docs/cli/includes/_create.md index e82feeceaa..4bdf40e27c 100644 --- a/docs/cli/_create.md +++ b/docs/cli/includes/_create.md @@ -18,6 +18,8 @@ quarto create [type] [commands...] |`--log-format` |`` |Log format (plain, json-stream) | |`--quiet` | |Suppress console output. | |`--profile` | |Active project profile(s) | + + ## Commands |Command |Description | diff --git a/docs/cli/includes/_dev-call-cli-info.md b/docs/cli/includes/_dev-call-cli-info.md new file mode 100644 index 0000000000..3817fd45d5 --- /dev/null +++ b/docs/cli/includes/_dev-call-cli-info.md @@ -0,0 +1,26 @@ +Generate JSON information about the Quarto CLI. + +``` {.bash} +quarto dev-call cli-info +``` + + +## Options + +|Flags |Arguments |Description | +|:--------------|:----------|:------------------------------------------| +|`-h`, `--help` | |Show this help. | +|`--log` |`` |Path to log file | +|`--log-level` |`` |Log level (info, warning, error, critical) | +|`--log-format` |`` |Log format (plain, json-stream) | +|`--quiet` | |Suppress console output. | + + +## Commands + +|Command |Description | +|:-------|:--------------------------------------------| +|`help` |Show this help or the help of a sub-command. | + + + diff --git a/docs/cli/_dev-call.md b/docs/cli/includes/_dev-call.md similarity index 99% rename from docs/cli/_dev-call.md rename to docs/cli/includes/_dev-call.md index 32c79bf7d0..5a8b75e773 100644 --- a/docs/cli/_dev-call.md +++ b/docs/cli/includes/_dev-call.md @@ -10,6 +10,8 @@ quarto dev-call |Flags |Arguments |Description | |:--------------|:---------|:---------------| |`-h`, `--help` | |Show this help. | + + ## Commands |Command |Description | diff --git a/docs/cli/_inspect.md b/docs/cli/includes/_inspect.md similarity index 97% rename from docs/cli/_inspect.md rename to docs/cli/includes/_inspect.md index 6407f8999e..5389e8a2bc 100644 --- a/docs/cli/_inspect.md +++ b/docs/cli/includes/_inspect.md @@ -20,6 +20,8 @@ quarto inspect [path] [output] |`--log-format` |`` |Log format (plain, json-stream) | |`--quiet` | |Suppress console output. | |`--profile` | |Active project profile(s) | + + ## Commands |Command |Description | @@ -33,19 +35,19 @@ quarto inspect [path] [output] ``` {.bash filename='Terminal'} quarto inspect ``` -## Examples + ### Inspect project in directory ``` {.bash filename='Terminal'} quarto inspect myproject ``` -## Examples + ### Inspect input path ``` {.bash filename='Terminal'} quarto inspect document.md ``` -## Examples + ### Inspect input path and write to file ``` {.bash filename='Terminal'} diff --git a/docs/cli/_install.md b/docs/cli/includes/_install.md similarity index 98% rename from docs/cli/_install.md rename to docs/cli/includes/_install.md index 7e25fff8e9..13cfdf21fe 100644 --- a/docs/cli/_install.md +++ b/docs/cli/includes/_install.md @@ -17,6 +17,8 @@ quarto install [target...] |`--log-format` |`` |Log format (plain, json-stream) | |`--quiet` | |Suppress console output. | |`--profile` | |Active project profile(s) | + + ## Commands |Command |Description | @@ -30,13 +32,13 @@ quarto install [target...] ``` {.bash filename='Terminal'} quarto install tinytex ``` -## Examples + ### Install Chromium ``` {.bash filename='Terminal'} quarto install chromium ``` -## Examples + ### Choose tool to install ``` {.bash filename='Terminal'} diff --git a/docs/cli/_list.md b/docs/cli/includes/_list.md similarity index 98% rename from docs/cli/_list.md rename to docs/cli/includes/_list.md index 9390515468..d074c33b8a 100644 --- a/docs/cli/_list.md +++ b/docs/cli/includes/_list.md @@ -15,6 +15,8 @@ quarto list |`--log-format` |`` |Log format (plain, json-stream) | |`--quiet` | |Suppress console output. | |`--profile` | |Active project profile(s) | + + ## Commands |Command |Description | @@ -28,7 +30,7 @@ quarto list ``` {.bash filename='Terminal'} quarto list extensions ``` -## Examples + ### List global tools ``` {.bash filename='Terminal'} diff --git a/docs/cli/_pandoc.md b/docs/cli/includes/_pandoc.md similarity index 99% rename from docs/cli/_pandoc.md rename to docs/cli/includes/_pandoc.md index 7f54dac843..76f241c6e8 100644 --- a/docs/cli/_pandoc.md +++ b/docs/cli/includes/_pandoc.md @@ -18,6 +18,8 @@ quarto pandoc [...args] |`--log-format` |`` |Log format (plain, json-stream) | |`--quiet` | |Suppress console output. | |`--profile` | |Active project profile(s) | + + ## Commands |Command |Description | @@ -31,7 +33,7 @@ quarto pandoc [...args] ``` {.bash filename='Terminal'} quarto pandoc document.md --to html --output document.html ``` -## Examples + ### List Pandoc output formats ``` {.bash filename='Terminal'} diff --git a/docs/cli/_preview.md b/docs/cli/includes/_preview.md similarity index 98% rename from docs/cli/_preview.md rename to docs/cli/includes/_preview.md index ef9a68e60f..6d6738dec9 100644 --- a/docs/cli/_preview.md +++ b/docs/cli/includes/_preview.md @@ -34,6 +34,8 @@ If the port is not available then a random port between 3000 and 8000 will be se |`--log-format` |`` |Log format (plain, json-stream) | |`--quiet` | |Suppress console output. | |`--profile` | |Active project profile(s) | + + ## Commands |Command |Description | @@ -47,43 +49,43 @@ If the port is not available then a random port between 3000 and 8000 will be se ``` {.bash filename='Terminal'} quarto preview doc.qmd ``` -## Examples + ### Preview document with render command line args ``` {.bash filename='Terminal'} quarto preview doc.qmd --toc ``` -## Examples + ### Preview document (don't watch for input changes) ``` {.bash filename='Terminal'} quarto preview doc.qmd --no-watch-inputs ``` -## Examples + ### Preview website with most recent execution results ``` {.bash filename='Terminal'} quarto preview ``` -## Examples + ### Previewing website using a specific port ``` {.bash filename='Terminal'} quarto preview --port 4444 ``` -## Examples + ### Preview website (don't open a browser) ``` {.bash filename='Terminal'} quarto preview --no-browser ``` -## Examples + ### Fully render all website/book formats then preview ``` {.bash filename='Terminal'} quarto preview --render all ``` -## Examples + ### Fully render the html format then preview ``` {.bash filename='Terminal'} diff --git a/docs/cli/_publish.md b/docs/cli/includes/_publish.md similarity index 95% rename from docs/cli/_publish.md rename to docs/cli/includes/_publish.md index e1676524b3..b74f9cf1b7 100644 --- a/docs/cli/_publish.md +++ b/docs/cli/includes/_publish.md @@ -34,6 +34,8 @@ quarto publish [provider] [path] |`--log-format` |`` |Log format (plain, json-stream) | |`--quiet` | |Suppress console output. | |`--profile` | |Active project profile(s) | + + ## Commands |Command |Description | @@ -47,73 +49,73 @@ quarto publish [provider] [path] ``` {.bash filename='Terminal'} quarto publish ``` -## Examples + ### Publish document (prompt for provider) ``` {.bash filename='Terminal'} quarto publish document.qmd ``` -## Examples + ### Publish project to Hugging Face Spaces ``` {.bash filename='Terminal'} quarto publish huggingface ``` -## Examples + ### Publish project to Netlify ``` {.bash filename='Terminal'} quarto publish netlify ``` -## Examples + ### Publish with explicit target ``` {.bash filename='Terminal'} quarto publish netlify --id DA36416-F950-4647-815C-01A24233E294 ``` -## Examples + ### Publish project to GitHub Pages ``` {.bash filename='Terminal'} quarto publish gh-pages ``` -## Examples + ### Publish project to Posit Connect ``` {.bash filename='Terminal'} quarto publish connect ``` -## Examples + ### Publish with explicit credentials ``` {.bash filename='Terminal'} quarto publish connect --server example.com --token 01A24233E294 ``` -## Examples + ### Publish project to Posit Cloud ``` {.bash filename='Terminal'} quarto publish posit-cloud ``` -## Examples + ### Publish without confirmation prompt ``` {.bash filename='Terminal'} quarto publish --no-prompt ``` -## Examples + ### Publish without rendering ``` {.bash filename='Terminal'} quarto publish --no-render ``` -## Examples + ### Publish without opening browser ``` {.bash filename='Terminal'} quarto publish --no-browser ``` -## Examples + ### Manage/remove publishing accounts ``` {.bash filename='Terminal'} diff --git a/docs/cli/_remove.md b/docs/cli/includes/_remove.md similarity index 99% rename from docs/cli/_remove.md rename to docs/cli/includes/_remove.md index 48250f2fe8..4873d5c46b 100644 --- a/docs/cli/_remove.md +++ b/docs/cli/includes/_remove.md @@ -17,6 +17,8 @@ quarto remove [target...] |`--log-format` |`` |Log format (plain, json-stream) | |`--quiet` | |Suppress console output. | |`--profile` | |Active project profile(s) | + + ## Commands |Command |Description | diff --git a/docs/cli/_render.md b/docs/cli/includes/_render.md similarity index 98% rename from docs/cli/_render.md rename to docs/cli/includes/_render.md index ed24366fc0..c07c04a1c9 100644 --- a/docs/cli/_render.md +++ b/docs/cli/includes/_render.md @@ -33,6 +33,8 @@ quarto render [input:string] [...args] |`--log-format` |`` |Log format (plain, json-stream) | |`--quiet` | |Suppress console output. | |`--profile` | |Active project profile(s) | + + ## Commands |Command |Description | @@ -48,7 +50,7 @@ quarto render document.qmd quarto render document.qmd --to html quarto render document.qmd --to pdf --toc ``` -## Examples + ### Render Notebook ``` {.bash filename='Terminal'} @@ -56,21 +58,21 @@ quarto render notebook.ipynb quarto render notebook.ipynb --to docx quarto render notebook.ipynb --to pdf --toc ``` -## Examples + ### Render Project ``` {.bash filename='Terminal'} quarto render quarto render projdir ``` -## Examples + ### Render w/ Metadata ``` {.bash filename='Terminal'} quarto render document.qmd -M echo:false quarto render document.qmd -M code-fold:true ``` -## Examples + ### Render to Stdout ``` {.bash filename='Terminal'} diff --git a/docs/cli/_run.md b/docs/cli/includes/_run.md similarity index 99% rename from docs/cli/_run.md rename to docs/cli/includes/_run.md index 98c193c956..1bc9ea83e7 100644 --- a/docs/cli/_run.md +++ b/docs/cli/includes/_run.md @@ -18,6 +18,8 @@ quarto run [script:string] [...args] |`--log-format` |`` |Log format (plain, json-stream) | |`--quiet` | |Suppress console output. | |`--profile` | |Active project profile(s) | + + ## Commands |Command |Description | diff --git a/docs/cli/_serve.md b/docs/cli/includes/_serve.md similarity index 99% rename from docs/cli/_serve.md rename to docs/cli/includes/_serve.md index a6910e0e37..4ab5b66b1c 100644 --- a/docs/cli/_serve.md +++ b/docs/cli/includes/_serve.md @@ -21,6 +21,8 @@ quarto serve [input:string] |`--log-format` |`` |Log format (plain, json-stream) | |`--quiet` | |Suppress console output. | |`--profile` | |Active project profile(s) | + + ## Commands |Command |Description | @@ -34,7 +36,7 @@ quarto serve [input:string] ``` {.bash filename='Terminal'} quarto serve dashboard.qmd ``` -## Examples + ### Serve a document without rendering ``` {.bash filename='Terminal'} diff --git a/docs/cli/_tools.md b/docs/cli/includes/_tools.md similarity index 99% rename from docs/cli/_tools.md rename to docs/cli/includes/_tools.md index 684ca284dd..778e2ae619 100644 --- a/docs/cli/_tools.md +++ b/docs/cli/includes/_tools.md @@ -10,6 +10,8 @@ quarto tools |Flags |Arguments |Description | |:--------------|:---------|:---------------| |`-h`, `--help` | |Show this help. | + + ## Commands |Command |Description | diff --git a/docs/cli/_typst.md b/docs/cli/includes/_typst.md similarity index 99% rename from docs/cli/_typst.md rename to docs/cli/includes/_typst.md index eaaf1e6c14..07ee838158 100644 --- a/docs/cli/_typst.md +++ b/docs/cli/includes/_typst.md @@ -18,6 +18,8 @@ quarto typst [...args] |`--log-format` |`` |Log format (plain, json-stream) | |`--quiet` | |Suppress console output. | |`--profile` | |Active project profile(s) | + + ## Commands |Command |Description | @@ -31,7 +33,7 @@ quarto typst [...args] ``` {.bash filename='Terminal'} quarto typst compile document.typ ``` -## Examples + ### List all discovered fonts in system and custom font paths ``` {.bash filename='Terminal'} diff --git a/docs/cli/_uninstall.md b/docs/cli/includes/_uninstall.md similarity index 99% rename from docs/cli/_uninstall.md rename to docs/cli/includes/_uninstall.md index 922301fbfe..a9f52ecb58 100644 --- a/docs/cli/_uninstall.md +++ b/docs/cli/includes/_uninstall.md @@ -17,6 +17,8 @@ quarto uninstall [tool] |`--log-format` |`` |Log format (plain, json-stream) | |`--quiet` | |Suppress console output. | |`--profile` | |Active project profile(s) | + + ## Commands |Command |Description | diff --git a/docs/cli/_update.md b/docs/cli/includes/_update.md similarity index 97% rename from docs/cli/_update.md rename to docs/cli/includes/_update.md index 7350b0b34e..79bcec98ca 100644 --- a/docs/cli/_update.md +++ b/docs/cli/includes/_update.md @@ -17,6 +17,8 @@ quarto update [target...] |`--log-format` |`` |Log format (plain, json-stream) | |`--quiet` | |Suppress console output. | |`--profile` | |Active project profile(s) | + + ## Commands |Command |Description | @@ -30,31 +32,31 @@ quarto update [target...] ``` {.bash filename='Terminal'} quarto update extension / ``` -## Examples + ### Update extension (file) ``` {.bash filename='Terminal'} quarto update extension ``` -## Examples + ### Update extension (url) ``` {.bash filename='Terminal'} quarto update extension ``` -## Examples + ### Update TinyTeX ``` {.bash filename='Terminal'} quarto update tool tinytex ``` -## Examples + ### Update Chromium ``` {.bash filename='Terminal'} quarto update tool chromium ``` -## Examples + ### Choose tool to update ``` {.bash filename='Terminal'} diff --git a/docs/cli/includes/_use-binder.md b/docs/cli/includes/_use-binder.md new file mode 100644 index 0000000000..3609c1be73 --- /dev/null +++ b/docs/cli/includes/_use-binder.md @@ -0,0 +1,29 @@ +Configure the current project with Binder support. + +``` {.bash} +quarto use binder +``` + + +## Options + +|Flags |Arguments |Description | +|:--------------|:----------|:------------------------------------------| +|`--no-prompt` | |Do not prompt to confirm actions | +|`--log` |`` |Path to log file | +|`--log-level` |`` |Log level (info, warning, error, critical) | +|`--log-format` |`` |Log format (plain, json-stream) | +|`--quiet` | |Suppress console output. | +|`--profile` | |Active project profile(s) | + + + + + +## Examples +### Configure project to use Binder + +``` {.bash filename='Terminal'} +quarto use binder +``` + diff --git a/docs/cli/includes/_use-template.md b/docs/cli/includes/_use-template.md new file mode 100644 index 0000000000..ef7a605e16 --- /dev/null +++ b/docs/cli/includes/_use-template.md @@ -0,0 +1,28 @@ +Use a Quarto template for this directory or project. + +``` {.bash} +quarto use template +``` + + +## Options + +|Flags |Arguments |Description | +|:--------------|:----------|:------------------------------------------| +|`--no-prompt` | |Do not prompt to confirm actions | +|`--log` |`` |Path to log file | +|`--log-level` |`` |Log level (info, warning, error, critical) | +|`--log-format` |`` |Log format (plain, json-stream) | +|`--quiet` | |Suppress console output. | + + + + + +## Examples +### Use a template from Github + +``` {.bash filename='Terminal'} +quarto use template / +``` + diff --git a/docs/cli/_use.md b/docs/cli/includes/_use.md similarity index 99% rename from docs/cli/_use.md rename to docs/cli/includes/_use.md index 105de289ab..e032a4fe51 100644 --- a/docs/cli/_use.md +++ b/docs/cli/includes/_use.md @@ -10,6 +10,8 @@ quarto use [target:string] |Flags |Arguments |Description | |:-------------|:---------|:--------------------------------| |`--no-prompt` | |Do not prompt to confirm actions | + + ## Commands |Command |Description | diff --git a/docs/cli/inspect.qmd b/docs/cli/inspect.qmd index 1c40fc23d3..300e54be58 100644 --- a/docs/cli/inspect.qmd +++ b/docs/cli/inspect.qmd @@ -2,5 +2,5 @@ title: 'inspect' --- -{{< include _inspect.md >}} +{{< include includes/_inspect.md >}} diff --git a/docs/cli/install.qmd b/docs/cli/install.qmd index 707b550235..19a8de7c03 100644 --- a/docs/cli/install.qmd +++ b/docs/cli/install.qmd @@ -2,5 +2,5 @@ title: 'install' --- -{{< include _install.md >}} +{{< include includes/_install.md >}} diff --git a/docs/cli/list.qmd b/docs/cli/list.qmd index 6ee6f5e676..639d7df920 100644 --- a/docs/cli/list.qmd +++ b/docs/cli/list.qmd @@ -2,5 +2,5 @@ title: 'list' --- -{{< include _list.md >}} +{{< include includes/_list.md >}} diff --git a/docs/cli/pandoc.qmd b/docs/cli/pandoc.qmd index 20db3abe0d..9df3ee4c17 100644 --- a/docs/cli/pandoc.qmd +++ b/docs/cli/pandoc.qmd @@ -2,5 +2,5 @@ title: 'pandoc' --- -{{< include _pandoc.md >}} +{{< include includes/_pandoc.md >}} diff --git a/docs/cli/preview.qmd b/docs/cli/preview.qmd index e02b58a78f..40b9d181e6 100644 --- a/docs/cli/preview.qmd +++ b/docs/cli/preview.qmd @@ -2,5 +2,5 @@ title: 'preview' --- -{{< include _preview.md >}} +{{< include includes/_preview.md >}} diff --git a/docs/cli/publish.qmd b/docs/cli/publish.qmd index 3681b8055c..1c9e1490c2 100644 --- a/docs/cli/publish.qmd +++ b/docs/cli/publish.qmd @@ -2,5 +2,5 @@ title: 'publish' --- -{{< include _publish.md >}} +{{< include includes/_publish.md >}} diff --git a/docs/cli/remove.qmd b/docs/cli/remove.qmd index 09f5dffe11..94298946b2 100644 --- a/docs/cli/remove.qmd +++ b/docs/cli/remove.qmd @@ -2,5 +2,5 @@ title: 'remove' --- -{{< include _remove.md >}} +{{< include includes/_remove.md >}} diff --git a/docs/cli/render.qmd b/docs/cli/render.qmd index e23c7de2d6..23ac81b429 100644 --- a/docs/cli/render.qmd +++ b/docs/cli/render.qmd @@ -2,5 +2,5 @@ title: 'render' --- -{{< include _render.md >}} +{{< include includes/_render.md >}} diff --git a/docs/cli/run.qmd b/docs/cli/run.qmd index 4a26a3728c..46883f3f9b 100644 --- a/docs/cli/run.qmd +++ b/docs/cli/run.qmd @@ -2,5 +2,5 @@ title: 'run' --- -{{< include _run.md >}} +{{< include includes/_run.md >}} diff --git a/docs/cli/serve.qmd b/docs/cli/serve.qmd index f56919f9fa..846a238f76 100644 --- a/docs/cli/serve.qmd +++ b/docs/cli/serve.qmd @@ -2,5 +2,5 @@ title: 'serve' --- -{{< include _serve.md >}} +{{< include includes/_serve.md >}} diff --git a/docs/cli/tmp.md b/docs/cli/tmp.md deleted file mode 100644 index ed24366fc0..0000000000 --- a/docs/cli/tmp.md +++ /dev/null @@ -1,79 +0,0 @@ -Render files or projects to various document types. - -``` {.bash} -quarto render [input:string] [...args] -``` - - -## Options - -|Flags |Arguments |Description | -|:--------------------------|:----------|:----------------------------------------------------------------| -|`-h`, `--help` | |Show this help. | -|`-t`, `--to` | |Specify output format(s). | -|`-o`, `--output` | |Write output to FILE (use '--output -' for stdout). | -|`--output-dir` | |Write output to DIR (path is input/project relative) | -|`-M`, `--metadata` | |Metadata value (KEY:VALUE). | -|`--site-url` | |Override site-url for website or book output | -|`--execute` | |Execute code (--no-execute to skip execution). | -|`-P`, `--execute-param` | |Execution parameter (KEY:VALUE). | -|`--execute-params` | |YAML file with execution parameters. | -|`--execute-dir` | |Working directory for code execution. | -|`--execute-daemon` | |Keep Jupyter kernel alive (defaults to 300 seconds). | -|`--execute-daemon-restart` | |Restart keepalive Jupyter kernel before render. | -|`--execute-debug` | |Show debug output when executing computations. | -|`--use-freezer` | |Force use of frozen computations for an incremental file render. | -|`--cache` | |Cache execution output (--no-cache to prevent cache). | -|`--cache-refresh` | |Force refresh of execution cache. | -|`--no-clean` | |Do not clean project output-dir prior to render | -|`--debug` | |Leave intermediate files in place after render. | -|`pandoc-args...` | |Additional pandoc command line arguments. | -|`--log` |`` |Path to log file | -|`--log-level` |`` |Log level (info, warning, error, critical) | -|`--log-format` |`` |Log format (plain, json-stream) | -|`--quiet` | |Suppress console output. | -|`--profile` | |Active project profile(s) | -## Commands - -|Command |Description | -|:-------|:--------------------------------------------| -|`help` |Show this help or the help of a sub-command. | - - -## Examples -### Render Markdown - -``` {.bash filename='Terminal'} -quarto render document.qmd -quarto render document.qmd --to html -quarto render document.qmd --to pdf --toc -``` -## Examples -### Render Notebook - -``` {.bash filename='Terminal'} -quarto render notebook.ipynb -quarto render notebook.ipynb --to docx -quarto render notebook.ipynb --to pdf --toc -``` -## Examples -### Render Project - -``` {.bash filename='Terminal'} -quarto render -quarto render projdir -``` -## Examples -### Render w/ Metadata - -``` {.bash filename='Terminal'} -quarto render document.qmd -M echo:false -quarto render document.qmd -M code-fold:true -``` -## Examples -### Render to Stdout - -``` {.bash filename='Terminal'} -quarto render document.qmd --output - -``` - diff --git a/docs/cli/tools.qmd b/docs/cli/tools.qmd index 473dd04b6e..dd33f25559 100644 --- a/docs/cli/tools.qmd +++ b/docs/cli/tools.qmd @@ -2,5 +2,5 @@ title: 'tools' --- -{{< include _tools.md >}} +{{< include includes/_tools.md >}} diff --git a/docs/cli/typst.qmd b/docs/cli/typst.qmd index 1da45965dd..783815d0f1 100644 --- a/docs/cli/typst.qmd +++ b/docs/cli/typst.qmd @@ -2,5 +2,5 @@ title: 'typst' --- -{{< include _typst.md >}} +{{< include includes/_typst.md >}} diff --git a/docs/cli/uninstall.qmd b/docs/cli/uninstall.qmd index b9c52febb3..8a7adb6f58 100644 --- a/docs/cli/uninstall.qmd +++ b/docs/cli/uninstall.qmd @@ -2,5 +2,5 @@ title: 'uninstall' --- -{{< include _uninstall.md >}} +{{< include includes/_uninstall.md >}} diff --git a/docs/cli/update.qmd b/docs/cli/update.qmd index 8a0a9ed534..614613fe1b 100644 --- a/docs/cli/update.qmd +++ b/docs/cli/update.qmd @@ -2,5 +2,5 @@ title: 'update' --- -{{< include _update.md >}} +{{< include includes/_update.md >}} diff --git a/docs/cli/use.qmd b/docs/cli/use.qmd index 0d4ace9a3b..915420e711 100644 --- a/docs/cli/use.qmd +++ b/docs/cli/use.qmd @@ -1,6 +1,12 @@ --- title: 'use' +shift-heading-level-by: 1 --- -{{< include _use.md >}} +# use template +{{< include includes/_use-template.md >}} + +# use binder + +{{< include includes/_use-binder.md >}} diff --git a/docs/cli/generate-md.R b/tools/reference-cli-generate-md.R similarity index 63% rename from docs/cli/generate-md.R rename to tools/reference-cli-generate-md.R index d24e1539c4..6139a771c7 100644 --- a/docs/cli/generate-md.R +++ b/tools/reference-cli-generate-md.R @@ -1,7 +1,14 @@ +# Generates .md files in docs/cli/includes/ from `cli-info.json` in docs/cli/ +# Run with: +# quarto run tools/generate-md.R + library(jsonlite) library(knitr) library(dplyr) library(tidyr) +library(here) + +# Helper Functions ------------------------------------------------------- heading <- function(text, level = 2) { paste0(strrep("#", level), " ", text, "\n") @@ -35,7 +42,10 @@ process_options <- function(options) { } process_commands <- function(commands) { - tibble(commands = commands) |> + if (length(commands) == 0) { + return("") + } + commands_table <- tibble(commands = commands) |> unnest_wider(commands) |> mutate(name = paste0("`", name, "`")) |> select(name, description) |> @@ -43,6 +53,7 @@ process_commands <- function(commands) { col.names = c("Command", "Description"), ) |> paste(collapse = "\n") + paste(heading("Commands", 2), commands_table, sep = "\n") } process_examples <- function(examples) { @@ -63,7 +74,8 @@ process_examples <- function(examples) { name = heading(name, 3), text = paste0(name, description) ) |> - pull(text) + pull(text) |> + paste(collapse = "\n") paste0(heading("Examples", 2), example_text, collapse = "") } @@ -79,7 +91,7 @@ md_content <- function(name, description, usage, options, commands, examples) { "\n", heading("Options"), options_table, - heading("Commands"), + "\n", commands_table, "\n", examples_text, @@ -88,14 +100,40 @@ md_content <- function(name, description, usage, options, commands, examples) { ) } -cli_json <- read_json("cli-info.json") + +# Read and process JSON -------------------------------------------------- + +cli_json <- read_json(here("docs", "cli", "cli-info.json")) +cat("cli-info.json version: ", cli_json$version, "\n") commands <- cli_json$commands -commands_content <- tibble(commands) |> +exclude <- c("create-project", "editor-support") + +commands_tbl <- tibble(commands) |> unnest_wider(commands) |> - rowwise() |> + filter(!(name %in% exclude)) |> + rowwise() + +# Expand subcommands that arent "help" +subcommands <- + commands_tbl |> + filter(!(length(commands) == 1 & commands[[1]]["name"] == "help")) |> + unnest(commands) |> + unnest_wider(commands, names_sep = "_") |> + filter(commands_name != "help") |> + mutate(commands_name = paste(name, commands_name)) |> + select(starts_with("commands_")) |> + rename_with(~ gsub("commands_", "", .x)) + +commands_content <- commands_tbl |> + bind_rows(subcommands) |> mutate( - filename = paste0("_", name, ".md"), + filename = here( + "docs", + "cli", + "includes", + paste0("_", gsub(" ", "-", name), ".md") + ), content = md_content( name, description, From 903ea860bde9f7e04ca619178f3d8f56edcd9cb1 Mon Sep 17 00:00:00 2001 From: Charlotte Wickham Date: Thu, 8 May 2025 12:40:33 -0700 Subject: [PATCH 05/18] Use 1.8.3 cli-info --- docs/cli/cli-info.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/cli/cli-info.json b/docs/cli/cli-info.json index 5771d0026f..45babcd6f6 100644 --- a/docs/cli/cli-info.json +++ b/docs/cli/cli-info.json @@ -1,5 +1,5 @@ { - "version": "99.9.9", + "version": "1.8.3", "commands": [ { "name": "render", From bb9aa7cc16cff76dbe33062919d53cf8791eb60f Mon Sep 17 00:00:00 2001 From: Charlotte Wickham Date: Thu, 8 May 2025 12:49:18 -0700 Subject: [PATCH 06/18] Add cli landing --- docs/cli/includes/_cli-commands.md | 24 ++++++++++++++++++++++++ docs/cli/index.qmd | 6 ++++++ tools/reference-cli-generate-md.R | 18 ++++++++++++++++-- 3 files changed, 46 insertions(+), 2 deletions(-) create mode 100644 docs/cli/includes/_cli-commands.md create mode 100644 docs/cli/index.qmd diff --git a/docs/cli/includes/_cli-commands.md b/docs/cli/includes/_cli-commands.md new file mode 100644 index 0000000000..e655b28c8d --- /dev/null +++ b/docs/cli/includes/_cli-commands.md @@ -0,0 +1,24 @@ +|name |description | +|:------------|:--------------------------------------------------------------------------| +|[render](render.qmd)|Render files or projects to various document types. | +|[preview](preview.qmd)|Render and preview a document or website project. | +|[serve](serve.qmd)|Serve a Shiny interactive document. | +|[create](create.qmd)|Create a Quarto project or extension | +|[use](use.qmd)|Automate document or project setup tasks. | +|[add](add.qmd)|Add an extension to this folder or project | +|[update](update.qmd)|Updates an extension or global dependency. | +|[remove](remove.qmd)|Removes an extension. | +|[convert](convert.qmd)|Convert documents to alternate representations. | +|[pandoc](pandoc.qmd)|Run the version of Pandoc embedded within Quarto. | +|[typst](typst.qmd)|Run the version of Typst embedded within Quarto. | +|[run](run.qmd)|Run a TypeScript, R, Python, or Lua script. | +|[list](list.qmd)|Lists an extension or global dependency. | +|[install](install.qmd)|Installs a global dependency (TinyTex or Chromium). | +|[uninstall](uninstall.qmd)|Removes an extension. | +|[tools](tools.qmd)|Display the status of Quarto installed dependencies | +|[publish](publish.qmd)|Publish a document or project to a provider. | +|[capabilities](capabilities.qmd)|Query for current capabilities (formats, engines, kernels etc.) | +|[inspect](inspect.qmd)|Inspect a Quarto project or input path. | +|[check](check.qmd)|Verify correct functioning of Quarto installation. | +|[call](call.qmd)|Access functions of Quarto subsystems such as its rendering engines. | +|[dev-call](dev-call.qmd)|Access internals of Quarto - this command is not intended for general use. | diff --git a/docs/cli/index.qmd b/docs/cli/index.qmd new file mode 100644 index 0000000000..5ad5939bf0 --- /dev/null +++ b/docs/cli/index.qmd @@ -0,0 +1,6 @@ +--- +title: CLI Commands +tbl-colwidths: [20, 80] +--- + +{{< include includes/_cli-commands.md >}} \ No newline at end of file diff --git a/tools/reference-cli-generate-md.R b/tools/reference-cli-generate-md.R index 6139a771c7..f1b04c3fdd 100644 --- a/tools/reference-cli-generate-md.R +++ b/tools/reference-cli-generate-md.R @@ -1,6 +1,8 @@ # Generates .md files in docs/cli/includes/ from `cli-info.json` in docs/cli/ -# Run with: -# quarto run tools/generate-md.R +# 1. Update JSON: +# quarto dev-call cli-info > docs/cli/cli-info.json +# 2. Generate .md with: +# quarto run tools/reference-cli-generate-md.R library(jsonlite) library(knitr) @@ -146,3 +148,15 @@ commands_content <- commands_tbl |> commands_content |> group_walk(~ with(.x, writeLines(content, filename))) + + +# Table for landing ------------------------------------------------------ + +commands_tbl |> + select(name, description) |> + mutate( + name = paste("[", name, "](", name, ".qmd)", sep = ""), + description = stringr::str_extract(description, "^[^\\n]+") + ) |> + knitr::kable() |> + writeLines(here("docs", "cli", "includes", "_cli-commands.md")) From a29e538f9dd92b9895386404f18d426ba1fcc33f Mon Sep 17 00:00:00 2001 From: Charlotte Wickham Date: Thu, 8 May 2025 12:52:05 -0700 Subject: [PATCH 07/18] Expand subcommands --- docs/cli/dev-call.qmd | 7 ++++++- docs/cli/use.qmd | 5 ++++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/cli/dev-call.qmd b/docs/cli/dev-call.qmd index 16d2ee1f21..84e13a0514 100644 --- a/docs/cli/dev-call.qmd +++ b/docs/cli/dev-call.qmd @@ -1,6 +1,11 @@ --- -title: 'dev-call' +shift-heading-level-by: 1 --- +# dev-call + {{< include includes/_dev-call.md >}} +# dev-call cli-info + +{{< include includes/_dev-call-cli-info.md >}} \ No newline at end of file diff --git a/docs/cli/use.qmd b/docs/cli/use.qmd index 915420e711..c1c81e4cce 100644 --- a/docs/cli/use.qmd +++ b/docs/cli/use.qmd @@ -1,8 +1,11 @@ --- -title: 'use' shift-heading-level-by: 1 --- +# use + +{{< include includes/_use.md >}} + # use template {{< include includes/_use-template.md >}} From 48d94bcd8748672122e4a222e6b977f1e3ad4108 Mon Sep 17 00:00:00 2001 From: Charlotte Wickham Date: Thu, 8 May 2025 13:22:23 -0700 Subject: [PATCH 08/18] Recurse into subcommands --- docs/cli/includes/_call-engine-julia-close.md | 28 ++++++++ docs/cli/includes/_call-engine-julia-kill.md | 27 +++++++ docs/cli/includes/_call-engine-julia-log.md | 27 +++++++ .../cli/includes/_call-engine-julia-status.md | 27 +++++++ docs/cli/includes/_call-engine-julia-stop.md | 27 +++++++ docs/cli/includes/_call-engine-julia.md | 32 +++++++++ tools/reference-cli-generate-md.R | 72 +++++++++++-------- 7 files changed, 212 insertions(+), 28 deletions(-) create mode 100644 docs/cli/includes/_call-engine-julia-close.md create mode 100644 docs/cli/includes/_call-engine-julia-kill.md create mode 100644 docs/cli/includes/_call-engine-julia-log.md create mode 100644 docs/cli/includes/_call-engine-julia-status.md create mode 100644 docs/cli/includes/_call-engine-julia-stop.md create mode 100644 docs/cli/includes/_call-engine-julia.md diff --git a/docs/cli/includes/_call-engine-julia-close.md b/docs/cli/includes/_call-engine-julia-close.md new file mode 100644 index 0000000000..3f8f506a94 --- /dev/null +++ b/docs/cli/includes/_call-engine-julia-close.md @@ -0,0 +1,28 @@ +Close the worker for a given notebook. If it is currently running, it will not be interrupted. + +``` {.bash} +quarto call engine julia close +``` + + +## Options + +|Flags |Arguments |Description | +|:---------------|:----------|:---------------------------------------------------------------| +|`--log` |`` |Path to log file | +|`--log-level` |`` |Log level (info, warning, error, critical) | +|`--log-format` |`` |Log format (plain, json-stream) | +|`--quiet` | |Suppress console output. | +|`--profile` | |Active project profile(s) | +|`-h`, `--help` | |Show this help. | +|`-f`, `--force` | |Force closing. This will terminate the worker if it is running. | + + +## Commands + +|Command |Description | +|:-------|:--------------------------------------------| +|`help` |Show this help or the help of a sub-command. | + + + diff --git a/docs/cli/includes/_call-engine-julia-kill.md b/docs/cli/includes/_call-engine-julia-kill.md new file mode 100644 index 0000000000..ce6deec6aa --- /dev/null +++ b/docs/cli/includes/_call-engine-julia-kill.md @@ -0,0 +1,27 @@ +Kill the control server if it is currently running. This will also kill all notebook worker processes. + +``` {.bash} +quarto call engine julia kill +``` + + +## Options + +|Flags |Arguments |Description | +|:--------------|:----------|:------------------------------------------| +|`--log` |`` |Path to log file | +|`--log-level` |`` |Log level (info, warning, error, critical) | +|`--log-format` |`` |Log format (plain, json-stream) | +|`--quiet` | |Suppress console output. | +|`--profile` | |Active project profile(s) | +|`-h`, `--help` | |Show this help. | + + +## Commands + +|Command |Description | +|:-------|:--------------------------------------------| +|`help` |Show this help or the help of a sub-command. | + + + diff --git a/docs/cli/includes/_call-engine-julia-log.md b/docs/cli/includes/_call-engine-julia-log.md new file mode 100644 index 0000000000..a21fceb1f8 --- /dev/null +++ b/docs/cli/includes/_call-engine-julia-log.md @@ -0,0 +1,27 @@ +Print the content of the julia server log file if it exists which can be used to diagnose problems. + +``` {.bash} +quarto call engine julia log +``` + + +## Options + +|Flags |Arguments |Description | +|:--------------|:----------|:------------------------------------------| +|`--log` |`` |Path to log file | +|`--log-level` |`` |Log level (info, warning, error, critical) | +|`--log-format` |`` |Log format (plain, json-stream) | +|`--quiet` | |Suppress console output. | +|`--profile` | |Active project profile(s) | +|`-h`, `--help` | |Show this help. | + + +## Commands + +|Command |Description | +|:-------|:--------------------------------------------| +|`help` |Show this help or the help of a sub-command. | + + + diff --git a/docs/cli/includes/_call-engine-julia-status.md b/docs/cli/includes/_call-engine-julia-status.md new file mode 100644 index 0000000000..3d65a6814c --- /dev/null +++ b/docs/cli/includes/_call-engine-julia-status.md @@ -0,0 +1,27 @@ +Get status information on the currently running Julia server process. + +``` {.bash} +quarto call engine julia status +``` + + +## Options + +|Flags |Arguments |Description | +|:--------------|:----------|:------------------------------------------| +|`--log` |`` |Path to log file | +|`--log-level` |`` |Log level (info, warning, error, critical) | +|`--log-format` |`` |Log format (plain, json-stream) | +|`--quiet` | |Suppress console output. | +|`--profile` | |Active project profile(s) | +|`-h`, `--help` | |Show this help. | + + +## Commands + +|Command |Description | +|:-------|:--------------------------------------------| +|`help` |Show this help or the help of a sub-command. | + + + diff --git a/docs/cli/includes/_call-engine-julia-stop.md b/docs/cli/includes/_call-engine-julia-stop.md new file mode 100644 index 0000000000..5d61ba3018 --- /dev/null +++ b/docs/cli/includes/_call-engine-julia-stop.md @@ -0,0 +1,27 @@ +Send a message to the server that it should close all notebooks and exit. This will fail if any notebooks are not idle. + +``` {.bash} +quarto call engine julia stop +``` + + +## Options + +|Flags |Arguments |Description | +|:--------------|:----------|:------------------------------------------| +|`--log` |`` |Path to log file | +|`--log-level` |`` |Log level (info, warning, error, critical) | +|`--log-format` |`` |Log format (plain, json-stream) | +|`--quiet` | |Suppress console output. | +|`--profile` | |Active project profile(s) | +|`-h`, `--help` | |Show this help. | + + +## Commands + +|Command |Description | +|:-------|:--------------------------------------------| +|`help` |Show this help or the help of a sub-command. | + + + diff --git a/docs/cli/includes/_call-engine-julia.md b/docs/cli/includes/_call-engine-julia.md new file mode 100644 index 0000000000..afcdccd8b9 --- /dev/null +++ b/docs/cli/includes/_call-engine-julia.md @@ -0,0 +1,32 @@ +Access functionality specific to the julia rendering engine. + +``` {.bash} +quarto call engine julia +``` + + +## Options + +|Flags |Arguments |Description | +|:--------------|:----------|:------------------------------------------| +|`--log` |`` |Path to log file | +|`--log-level` |`` |Log level (info, warning, error, critical) | +|`--log-format` |`` |Log format (plain, json-stream) | +|`--quiet` | |Suppress console output. | +|`--profile` | |Active project profile(s) | +|`-h`, `--help` | |Show this help. | + + +## Commands + +|Command |Description | +|:--------|:-----------------------------------------------------------------------------------------------------------------------| +|`help` |Show this help or the help of a sub-command. | +|`status` |Get status information on the currently running Julia server process. | +|`kill` |Kill the control server if it is currently running. This will also kill all notebook worker processes. | +|`log` |Print the content of the julia server log file if it exists which can be used to diagnose problems. | +|`close` |Close the worker for a given notebook. If it is currently running, it will not be interrupted. | +|`stop` |Send a message to the server that it should close all notebooks and exit. This will fail if any notebooks are not idle. | + + + diff --git a/tools/reference-cli-generate-md.R b/tools/reference-cli-generate-md.R index f1b04c3fdd..65e7085973 100644 --- a/tools/reference-cli-generate-md.R +++ b/tools/reference-cli-generate-md.R @@ -6,9 +6,8 @@ library(jsonlite) library(knitr) -library(dplyr) -library(tidyr) library(here) +library(tidyverse) # Helper Functions ------------------------------------------------------- @@ -110,25 +109,54 @@ cat("cli-info.json version: ", cli_json$version, "\n") commands <- cli_json$commands exclude <- c("create-project", "editor-support") +commands <- commands[!map_chr(commands, "name") %in% exclude] -commands_tbl <- tibble(commands) |> +# Recursively extract commands and subcommands +extract_commands <- function(commands, prefix = NULL) { + result <- list() + + for (cmd in commands) { + # Create full command name + full_name <- str_c(prefix, cmd$name, sep = " ") + + # Add current command to results + cmd$name <- full_name + result[[length(result) + 1]] <- cmd + + # Recursively process nested commands if they exist + if (!is.null(cmd$commands) && length(cmd$commands) > 0) { + nested_commands <- extract_commands(cmd$commands, prefix = full_name) + result <- c(result, nested_commands) + } + } + + return(result) +} + +# Table for landing ------------------------------------------------------ + +tibble(commands = commands) |> unnest_wider(commands) |> - filter(!(name %in% exclude)) |> - rowwise() + select(name, description) |> + mutate( + name = paste("[", name, "](", name, ".qmd)", sep = ""), + description = stringr::str_extract(description, "^[^\\n]+") + ) |> + knitr::kable() |> + writeLines(here("docs", "cli", "includes", "_cli-commands.md")) -# Expand subcommands that arent "help" -subcommands <- - commands_tbl |> - filter(!(length(commands) == 1 & commands[[1]]["name"] == "help")) |> - unnest(commands) |> - unnest_wider(commands, names_sep = "_") |> - filter(commands_name != "help") |> - mutate(commands_name = paste(name, commands_name)) |> - select(starts_with("commands_")) |> - rename_with(~ gsub("commands_", "", .x)) + +# Individual commands ---------------------------------------------------- + +all_commands <- extract_commands(commands) + +commands_tbl <- + tibble(commands = all_commands) |> + unnest_wider(commands) |> + filter(str_detect(name, "help", negate = TRUE)) |> + rowwise() commands_content <- commands_tbl |> - bind_rows(subcommands) |> mutate( filename = here( "docs", @@ -148,15 +176,3 @@ commands_content <- commands_tbl |> commands_content |> group_walk(~ with(.x, writeLines(content, filename))) - - -# Table for landing ------------------------------------------------------ - -commands_tbl |> - select(name, description) |> - mutate( - name = paste("[", name, "](", name, ".qmd)", sep = ""), - description = stringr::str_extract(description, "^[^\\n]+") - ) |> - knitr::kable() |> - writeLines(here("docs", "cli", "includes", "_cli-commands.md")) From e226257f46696d9de622a0ebd2ef74cde8fbbbd3 Mon Sep 17 00:00:00 2001 From: Charlotte Wickham Date: Thu, 8 May 2025 13:25:06 -0700 Subject: [PATCH 09/18] Add sub commands for call engine julia --- docs/cli/call.qmd | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/docs/cli/call.qmd b/docs/cli/call.qmd index 37abad571f..41fe4e9f8e 100644 --- a/docs/cli/call.qmd +++ b/docs/cli/call.qmd @@ -9,3 +9,27 @@ shift-heading-level-by: 1 {{< include includes/_call-engine.md >}} +# call engine julia + +{{< include includes/_call-engine-julia.md >}} + + +# call engine julia status + +{{< include includes/_call-engine-julia-status.md >}} + +# call engine julia kill + +{{< include includes/_call-engine-julia-kill.md >}} + +# call engine julia log + +{{< include includes/_call-engine-julia-log.md >}} + +# call engine julia close + +{{< include includes/_call-engine-julia-close.md >}} + +# call engine julia stop + +{{< include includes/_call-engine-julia-stop.md >}} \ No newline at end of file From 23bd5dff5481ec0f590407f205a22e880f6ca2f3 Mon Sep 17 00:00:00 2001 From: Charlotte Wickham Date: Thu, 8 May 2025 15:03:21 -0700 Subject: [PATCH 10/18] Change some headings --- _quarto.yml | 2 +- docs/cli/index.qmd | 2 +- docs/reference/reference.yml | 12 ++++++++++++ 3 files changed, 14 insertions(+), 2 deletions(-) diff --git a/_quarto.yml b/_quarto.yml index f8af6f4726..9e19f5ef78 100644 --- a/_quarto.yml +++ b/_quarto.yml @@ -588,7 +588,7 @@ website: href: docs/reference/metadata/crossref.qmd - text: "Brand" href: docs/reference/metadata/brand.qmd - - section: CLI Commands + - section: "quarto" contents: docs/cli/*.qmd - id: prerelease title: "Quarto 1.3" diff --git a/docs/cli/index.qmd b/docs/cli/index.qmd index 5ad5939bf0..df3d9be0ea 100644 --- a/docs/cli/index.qmd +++ b/docs/cli/index.qmd @@ -1,5 +1,5 @@ --- -title: CLI Commands +title: Command Line Reference tbl-colwidths: [20, 80] --- diff --git a/docs/reference/reference.yml b/docs/reference/reference.yml index 4c787abe5f..a9f003dc50 100644 --- a/docs/reference/reference.yml +++ b/docs/reference/reference.yml @@ -77,3 +77,15 @@ - text: "Brand" href: metadata/brand.qmd +- title: "Command Line" + links: + - text: "`quarto render`" + href: /docs/cli/render.qmd + - text: "`quarto preview`" + href: /docs/cli/preview.qmd + - text: "`quarto create`" + href: /docs/cli/create.qmd + - text: "`quarto publish`" + href: /docs/cli/publish.qmd + - text: "`quarto check`" + href: /docs/cli/check.qmd \ No newline at end of file From 75c8ffcb75f38425877852cb8df9c98abd109401 Mon Sep 17 00:00:00 2001 From: Charlotte Wickham Date: Thu, 8 May 2025 15:03:32 -0700 Subject: [PATCH 11/18] Use html tables --- docs/cli/includes/_add.md | 86 +++++++-- docs/cli/includes/_call-engine-julia-close.md | 80 ++++++-- docs/cli/includes/_call-engine-julia-kill.md | 74 +++++-- docs/cli/includes/_call-engine-julia-log.md | 74 +++++-- .../cli/includes/_call-engine-julia-status.md | 74 +++++-- docs/cli/includes/_call-engine-julia-stop.md | 74 +++++-- docs/cli/includes/_call-engine-julia.md | 99 ++++++++-- docs/cli/includes/_call-engine.md | 79 ++++++-- docs/cli/includes/_call.md | 49 ++++- docs/cli/includes/_capabilities.md | 74 +++++-- docs/cli/includes/_check.md | 86 +++++++-- docs/cli/includes/_cli-commands.md | 122 +++++++++--- docs/cli/includes/_convert.md | 86 +++++++-- docs/cli/includes/_create.md | 92 +++++++-- docs/cli/includes/_dev-call-cli-info.md | 68 ++++++- docs/cli/includes/_dev-call.md | 49 ++++- docs/cli/includes/_inspect.md | 74 +++++-- docs/cli/includes/_install.md | 86 +++++++-- docs/cli/includes/_list.md | 74 +++++-- docs/cli/includes/_pandoc.md | 74 +++++-- docs/cli/includes/_preview.md | 124 ++++++++++-- docs/cli/includes/_publish.md | 110 +++++++++-- docs/cli/includes/_remove.md | 86 +++++++-- docs/cli/includes/_render.md | 182 +++++++++++++++--- docs/cli/includes/_run.md | 74 +++++-- docs/cli/includes/_serve.md | 98 ++++++++-- docs/cli/includes/_tools.md | 44 ++++- docs/cli/includes/_typst.md | 74 +++++-- docs/cli/includes/_uninstall.md | 86 +++++++-- docs/cli/includes/_update.md | 86 +++++++-- docs/cli/includes/_use-binder.md | 53 ++++- docs/cli/includes/_use-template.md | 47 ++++- docs/cli/includes/_use.md | 49 ++++- tools/reference-cli-generate-md.R | 19 +- 34 files changed, 2289 insertions(+), 417 deletions(-) diff --git a/docs/cli/includes/_add.md b/docs/cli/includes/_add.md index abd200d799..47291ea3cd 100644 --- a/docs/cli/includes/_add.md +++ b/docs/cli/includes/_add.md @@ -7,23 +7,83 @@ quarto add ## Options -|Flags |Arguments |Description | -|:--------------|:---------------|:-------------------------------------------------------------------------------| -|`-h`, `--help` | |Show this help. | -|`--no-prompt` | |Do not prompt to confirm actions | -|`--embed` |`` |Embed this extension within another extension (used when authoring extensions). | -|`--log` |`` |Path to log file | -|`--log-level` |`` |Log level (info, warning, error, critical) | -|`--log-format` |`` |Log format (plain, json-stream) | -|`--quiet` | |Suppress console output. | -|`--profile` | |Active project profile(s) | + +```{=html} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Flags Arguments Description
-h, --help Show this help.
--no-prompt Do not prompt to confirm actions
--embed Embed this extension within another extension (used when authoring extensions).
--log Path to log file
--log-level Log level (info, warning, error, critical)
--log-format Log format (plain, json-stream)
--quiet Suppress console output.
--profile Active project profile(s)
+``` + ## Commands -|Command |Description | -|:-------|:--------------------------------------------| -|`help` |Show this help or the help of a sub-command. | + +```{=html} + + + + + + + + + + + + + +
Command Description
<code>help</code> Show this help or the help of a sub-command.
+``` + ## Examples diff --git a/docs/cli/includes/_call-engine-julia-close.md b/docs/cli/includes/_call-engine-julia-close.md index 3f8f506a94..0198789e7a 100644 --- a/docs/cli/includes/_call-engine-julia-close.md +++ b/docs/cli/includes/_call-engine-julia-close.md @@ -7,22 +7,78 @@ quarto call engine julia close ## Options -|Flags |Arguments |Description | -|:---------------|:----------|:---------------------------------------------------------------| -|`--log` |`` |Path to log file | -|`--log-level` |`` |Log level (info, warning, error, critical) | -|`--log-format` |`` |Log format (plain, json-stream) | -|`--quiet` | |Suppress console output. | -|`--profile` | |Active project profile(s) | -|`-h`, `--help` | |Show this help. | -|`-f`, `--force` | |Force closing. This will terminate the worker if it is running. | + +```{=html} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Flags Arguments Description
--log Path to log file
--log-level Log level (info, warning, error, critical)
--log-format Log format (plain, json-stream)
--quiet Suppress console output.
--profile Active project profile(s)
-h, --help Show this help.
-f, --force Force closing. This will terminate the worker if it is running.
+``` + ## Commands -|Command |Description | -|:-------|:--------------------------------------------| -|`help` |Show this help or the help of a sub-command. | + +```{=html} + + + + + + + + + + + + + +
Command Description
<code>help</code> Show this help or the help of a sub-command.
+``` + diff --git a/docs/cli/includes/_call-engine-julia-kill.md b/docs/cli/includes/_call-engine-julia-kill.md index ce6deec6aa..e6e0edb6bc 100644 --- a/docs/cli/includes/_call-engine-julia-kill.md +++ b/docs/cli/includes/_call-engine-julia-kill.md @@ -7,21 +7,73 @@ quarto call engine julia kill ## Options -|Flags |Arguments |Description | -|:--------------|:----------|:------------------------------------------| -|`--log` |`` |Path to log file | -|`--log-level` |`` |Log level (info, warning, error, critical) | -|`--log-format` |`` |Log format (plain, json-stream) | -|`--quiet` | |Suppress console output. | -|`--profile` | |Active project profile(s) | -|`-h`, `--help` | |Show this help. | + +```{=html} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Flags Arguments Description
--log Path to log file
--log-level Log level (info, warning, error, critical)
--log-format Log format (plain, json-stream)
--quiet Suppress console output.
--profile Active project profile(s)
-h, --help Show this help.
+``` + ## Commands -|Command |Description | -|:-------|:--------------------------------------------| -|`help` |Show this help or the help of a sub-command. | + +```{=html} + + + + + + + + + + + + + +
Command Description
<code>help</code> Show this help or the help of a sub-command.
+``` + diff --git a/docs/cli/includes/_call-engine-julia-log.md b/docs/cli/includes/_call-engine-julia-log.md index a21fceb1f8..b434200c43 100644 --- a/docs/cli/includes/_call-engine-julia-log.md +++ b/docs/cli/includes/_call-engine-julia-log.md @@ -7,21 +7,73 @@ quarto call engine julia log ## Options -|Flags |Arguments |Description | -|:--------------|:----------|:------------------------------------------| -|`--log` |`` |Path to log file | -|`--log-level` |`` |Log level (info, warning, error, critical) | -|`--log-format` |`` |Log format (plain, json-stream) | -|`--quiet` | |Suppress console output. | -|`--profile` | |Active project profile(s) | -|`-h`, `--help` | |Show this help. | + +```{=html} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Flags Arguments Description
--log Path to log file
--log-level Log level (info, warning, error, critical)
--log-format Log format (plain, json-stream)
--quiet Suppress console output.
--profile Active project profile(s)
-h, --help Show this help.
+``` + ## Commands -|Command |Description | -|:-------|:--------------------------------------------| -|`help` |Show this help or the help of a sub-command. | + +```{=html} + + + + + + + + + + + + + +
Command Description
<code>help</code> Show this help or the help of a sub-command.
+``` + diff --git a/docs/cli/includes/_call-engine-julia-status.md b/docs/cli/includes/_call-engine-julia-status.md index 3d65a6814c..5bc01864c0 100644 --- a/docs/cli/includes/_call-engine-julia-status.md +++ b/docs/cli/includes/_call-engine-julia-status.md @@ -7,21 +7,73 @@ quarto call engine julia status ## Options -|Flags |Arguments |Description | -|:--------------|:----------|:------------------------------------------| -|`--log` |`` |Path to log file | -|`--log-level` |`` |Log level (info, warning, error, critical) | -|`--log-format` |`` |Log format (plain, json-stream) | -|`--quiet` | |Suppress console output. | -|`--profile` | |Active project profile(s) | -|`-h`, `--help` | |Show this help. | + +```{=html} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Flags Arguments Description
--log Path to log file
--log-level Log level (info, warning, error, critical)
--log-format Log format (plain, json-stream)
--quiet Suppress console output.
--profile Active project profile(s)
-h, --help Show this help.
+``` + ## Commands -|Command |Description | -|:-------|:--------------------------------------------| -|`help` |Show this help or the help of a sub-command. | + +```{=html} + + + + + + + + + + + + + +
Command Description
<code>help</code> Show this help or the help of a sub-command.
+``` + diff --git a/docs/cli/includes/_call-engine-julia-stop.md b/docs/cli/includes/_call-engine-julia-stop.md index 5d61ba3018..66649066dc 100644 --- a/docs/cli/includes/_call-engine-julia-stop.md +++ b/docs/cli/includes/_call-engine-julia-stop.md @@ -7,21 +7,73 @@ quarto call engine julia stop ## Options -|Flags |Arguments |Description | -|:--------------|:----------|:------------------------------------------| -|`--log` |`` |Path to log file | -|`--log-level` |`` |Log level (info, warning, error, critical) | -|`--log-format` |`` |Log format (plain, json-stream) | -|`--quiet` | |Suppress console output. | -|`--profile` | |Active project profile(s) | -|`-h`, `--help` | |Show this help. | + +```{=html} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Flags Arguments Description
--log Path to log file
--log-level Log level (info, warning, error, critical)
--log-format Log format (plain, json-stream)
--quiet Suppress console output.
--profile Active project profile(s)
-h, --help Show this help.
+``` + ## Commands -|Command |Description | -|:-------|:--------------------------------------------| -|`help` |Show this help or the help of a sub-command. | + +```{=html} + + + + + + + + + + + + + +
Command Description
<code>help</code> Show this help or the help of a sub-command.
+``` + diff --git a/docs/cli/includes/_call-engine-julia.md b/docs/cli/includes/_call-engine-julia.md index afcdccd8b9..74d12f7a69 100644 --- a/docs/cli/includes/_call-engine-julia.md +++ b/docs/cli/includes/_call-engine-julia.md @@ -7,26 +7,93 @@ quarto call engine julia ## Options -|Flags |Arguments |Description | -|:--------------|:----------|:------------------------------------------| -|`--log` |`` |Path to log file | -|`--log-level` |`` |Log level (info, warning, error, critical) | -|`--log-format` |`` |Log format (plain, json-stream) | -|`--quiet` | |Suppress console output. | -|`--profile` | |Active project profile(s) | -|`-h`, `--help` | |Show this help. | + +```{=html} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Flags Arguments Description
--log Path to log file
--log-level Log level (info, warning, error, critical)
--log-format Log format (plain, json-stream)
--quiet Suppress console output.
--profile Active project profile(s)
-h, --help Show this help.
+``` + ## Commands -|Command |Description | -|:--------|:-----------------------------------------------------------------------------------------------------------------------| -|`help` |Show this help or the help of a sub-command. | -|`status` |Get status information on the currently running Julia server process. | -|`kill` |Kill the control server if it is currently running. This will also kill all notebook worker processes. | -|`log` |Print the content of the julia server log file if it exists which can be used to diagnose problems. | -|`close` |Close the worker for a given notebook. If it is currently running, it will not be interrupted. | -|`stop` |Send a message to the server that it should close all notebooks and exit. This will fail if any notebooks are not idle. | + +```{=html} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Command Description
<code>help</code> Show this help or the help of a sub-command.
<code>status</code> Get status information on the currently running Julia server process.
<code>kill</code> Kill the control server if it is currently running. This will also kill all notebook worker processes.
<code>log</code> Print the content of the julia server log file if it exists which can be used to diagnose problems.
<code>close</code> Close the worker for a given notebook. If it is currently running, it will not be interrupted.
<code>stop</code> Send a message to the server that it should close all notebooks and exit. This will fail if any notebooks are not idle.
+``` + diff --git a/docs/cli/includes/_call-engine.md b/docs/cli/includes/_call-engine.md index bf290ef1f0..69bdbacd00 100644 --- a/docs/cli/includes/_call-engine.md +++ b/docs/cli/includes/_call-engine.md @@ -7,22 +7,77 @@ quarto call engine ## Options -|Flags |Arguments |Description | -|:--------------|:----------|:------------------------------------------| -|`-h`, `--help` | |Show this help. | -|`--log` |`` |Path to log file | -|`--log-level` |`` |Log level (info, warning, error, critical) | -|`--log-format` |`` |Log format (plain, json-stream) | -|`--quiet` | |Suppress console output. | -|`--profile` | |Active project profile(s) | + +```{=html} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Flags Arguments Description
-h, --help Show this help.
--log Path to log file
--log-level Log level (info, warning, error, critical)
--log-format Log format (plain, json-stream)
--quiet Suppress console output.
--profile Active project profile(s)
+``` + ## Commands -|Command |Description | -|:-------|:------------------------------------------------------------| -|`help` |Show this help or the help of a sub-command. | -|`julia` |Access functionality specific to the julia rendering engine. | + +```{=html} + + + + + + + + + + + + + + + + + +
Command Description
<code>help</code> Show this help or the help of a sub-command.
<code>julia</code> Access functionality specific to the julia rendering engine.
+``` + diff --git a/docs/cli/includes/_call.md b/docs/cli/includes/_call.md index dd28a5dd42..b0471061eb 100644 --- a/docs/cli/includes/_call.md +++ b/docs/cli/includes/_call.md @@ -7,17 +7,52 @@ quarto call ## Options -|Flags |Arguments |Description | -|:--------------|:---------|:---------------| -|`-h`, `--help` | |Show this help. | + +```{=html} + + + + + + + + + + + + + + + +
Flags Arguments Description
-h, --help Show this help.
+``` + ## Commands -|Command |Description | -|:--------|:----------------------------------------------------------------------| -|`help` |Show this help or the help of a sub-command. | -|`engine` |Access functionality specific to quarto's different rendering engines. | + +```{=html} + + + + + + + + + + + + + + + + + +
Command Description
<code>help</code> Show this help or the help of a sub-command.
<code>engine</code> Access functionality specific to quarto's different rendering engines.
+``` + diff --git a/docs/cli/includes/_capabilities.md b/docs/cli/includes/_capabilities.md index a7603f179f..5507955e53 100644 --- a/docs/cli/includes/_capabilities.md +++ b/docs/cli/includes/_capabilities.md @@ -7,21 +7,73 @@ quarto capabilities ## Options -|Flags |Arguments |Description | -|:--------------|:----------|:------------------------------------------| -|`-h`, `--help` | |Show this help. | -|`--log` |`` |Path to log file | -|`--log-level` |`` |Log level (info, warning, error, critical) | -|`--log-format` |`` |Log format (plain, json-stream) | -|`--quiet` | |Suppress console output. | -|`--profile` | |Active project profile(s) | + +```{=html} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Flags Arguments Description
-h, --help Show this help.
--log Path to log file
--log-level Log level (info, warning, error, critical)
--log-format Log format (plain, json-stream)
--quiet Suppress console output.
--profile Active project profile(s)
+``` + ## Commands -|Command |Description | -|:-------|:--------------------------------------------| -|`help` |Show this help or the help of a sub-command. | + +```{=html} + + + + + + + + + + + + + +
Command Description
<code>help</code> Show this help or the help of a sub-command.
+``` + diff --git a/docs/cli/includes/_check.md b/docs/cli/includes/_check.md index ef69c0c2d4..01425502fd 100644 --- a/docs/cli/includes/_check.md +++ b/docs/cli/includes/_check.md @@ -9,23 +9,83 @@ quarto check [target:string] ## Options -|Flags |Arguments |Description | -|:--------------|:----------|:--------------------------------------------------------------------| -|`-h`, `--help` | |Show this help. | -|`--output` |`` |Output as JSON to a file | -|`--no-strict` | |When set, will not fail if dependency versions don't match precisely | -|`--log` |`` |Path to log file | -|`--log-level` |`` |Log level (info, warning, error, critical) | -|`--log-format` |`` |Log format (plain, json-stream) | -|`--quiet` | |Suppress console output. | -|`--profile` | |Active project profile(s) | + +```{=html} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Flags Arguments Description
-h, --help Show this help.
--output Output as JSON to a file
--no-strict When set, will not fail if dependency versions don't match precisely
--log Path to log file
--log-level Log level (info, warning, error, critical)
--log-format Log format (plain, json-stream)
--quiet Suppress console output.
--profile Active project profile(s)
+``` + ## Commands -|Command |Description | -|:-------|:--------------------------------------------| -|`help` |Show this help or the help of a sub-command. | + +```{=html} + + + + + + + + + + + + + +
Command Description
<code>help</code> Show this help or the help of a sub-command.
+``` + ## Examples diff --git a/docs/cli/includes/_cli-commands.md b/docs/cli/includes/_cli-commands.md index e655b28c8d..54d834c906 100644 --- a/docs/cli/includes/_cli-commands.md +++ b/docs/cli/includes/_cli-commands.md @@ -1,24 +1,98 @@ -|name |description | -|:------------|:--------------------------------------------------------------------------| -|[render](render.qmd)|Render files or projects to various document types. | -|[preview](preview.qmd)|Render and preview a document or website project. | -|[serve](serve.qmd)|Serve a Shiny interactive document. | -|[create](create.qmd)|Create a Quarto project or extension | -|[use](use.qmd)|Automate document or project setup tasks. | -|[add](add.qmd)|Add an extension to this folder or project | -|[update](update.qmd)|Updates an extension or global dependency. | -|[remove](remove.qmd)|Removes an extension. | -|[convert](convert.qmd)|Convert documents to alternate representations. | -|[pandoc](pandoc.qmd)|Run the version of Pandoc embedded within Quarto. | -|[typst](typst.qmd)|Run the version of Typst embedded within Quarto. | -|[run](run.qmd)|Run a TypeScript, R, Python, or Lua script. | -|[list](list.qmd)|Lists an extension or global dependency. | -|[install](install.qmd)|Installs a global dependency (TinyTex or Chromium). | -|[uninstall](uninstall.qmd)|Removes an extension. | -|[tools](tools.qmd)|Display the status of Quarto installed dependencies | -|[publish](publish.qmd)|Publish a document or project to a provider. | -|[capabilities](capabilities.qmd)|Query for current capabilities (formats, engines, kernels etc.) | -|[inspect](inspect.qmd)|Inspect a Quarto project or input path. | -|[check](check.qmd)|Verify correct functioning of Quarto installation. | -|[call](call.qmd)|Access functions of Quarto subsystems such as its rendering engines. | -|[dev-call](dev-call.qmd)|Access internals of Quarto - this command is not intended for general use. | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
name description
[render](render.qmd) Render files or projects to various document types.
[preview](preview.qmd) Render and preview a document or website project.
[serve](serve.qmd) Serve a Shiny interactive document.
[create](create.qmd) Create a Quarto project or extension
[use](use.qmd) Automate document or project setup tasks.
[add](add.qmd) Add an extension to this folder or project
[update](update.qmd) Updates an extension or global dependency.
[remove](remove.qmd) Removes an extension.
[convert](convert.qmd) Convert documents to alternate representations.
[pandoc](pandoc.qmd) Run the version of Pandoc embedded within Quarto.
[typst](typst.qmd) Run the version of Typst embedded within Quarto.
[run](run.qmd) Run a TypeScript, R, Python, or Lua script.
[list](list.qmd) Lists an extension or global dependency.
[install](install.qmd) Installs a global dependency (TinyTex or Chromium).
[uninstall](uninstall.qmd) Removes an extension.
[tools](tools.qmd) Display the status of Quarto installed dependencies
[publish](publish.qmd) Publish a document or project to a provider.
[capabilities](capabilities.qmd) Query for current capabilities (formats, engines, kernels etc.)
[inspect](inspect.qmd) Inspect a Quarto project or input path.
[check](check.qmd) Verify correct functioning of Quarto installation.
[call](call.qmd) Access functions of Quarto subsystems such as its rendering engines.
[dev-call](dev-call.qmd) Access internals of Quarto - this command is not intended for general use.
diff --git a/docs/cli/includes/_convert.md b/docs/cli/includes/_convert.md index 0615e3d80a..328b2c2b41 100644 --- a/docs/cli/includes/_convert.md +++ b/docs/cli/includes/_convert.md @@ -7,23 +7,83 @@ quarto convert ## Options -|Flags |Arguments |Description | -|:----------------|:---------------|:------------------------------------------| -|`-h`, `--help` | |Show this help. | -|`-o`, `--output` |`[path:string]` |Write output to PATH. | -|`--with-ids` | |Include ids in conversion | -|`--log` |`` |Path to log file | -|`--log-level` |`` |Log level (info, warning, error, critical) | -|`--log-format` |`` |Log format (plain, json-stream) | -|`--quiet` | |Suppress console output. | -|`--profile` | |Active project profile(s) | + +```{=html} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Flags Arguments Description
-h, --help Show this help.
-o, --output [path:string] Write output to PATH.
--with-ids Include ids in conversion
--log Path to log file
--log-level Log level (info, warning, error, critical)
--log-format Log format (plain, json-stream)
--quiet Suppress console output.
--profile Active project profile(s)
+``` + ## Commands -|Command |Description | -|:-------|:--------------------------------------------| -|`help` |Show this help or the help of a sub-command. | + +```{=html} + + + + + + + + + + + + + +
Command Description
<code>help</code> Show this help or the help of a sub-command.
+``` + ## Examples diff --git a/docs/cli/includes/_create.md b/docs/cli/includes/_create.md index 4bdf40e27c..756793605f 100644 --- a/docs/cli/includes/_create.md +++ b/docs/cli/includes/_create.md @@ -7,24 +7,88 @@ quarto create [type] [commands...] ## Options -|Flags |Arguments |Description | -|:--------------|:-----------------|:------------------------------------------------------------| -|`-h`, `--help` | |Show this help. | -|`--open` |`[editor:string]` |Open new artifact in this editor (positron, vscode, rstudio) | -|`--no-open` | |Do not open in an editor | -|`--no-prompt` | |Do not prompt to confirm actions | -|`--log` |`` |Path to log file | -|`--log-level` |`` |Log level (info, warning, error, critical) | -|`--log-format` |`` |Log format (plain, json-stream) | -|`--quiet` | |Suppress console output. | -|`--profile` | |Active project profile(s) | + +```{=html} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Flags Arguments Description
-h, --help Show this help.
--open [editor:string] Open new artifact in this editor (positron, vscode, rstudio)
--no-open Do not open in an editor
--no-prompt Do not prompt to confirm actions
--log Path to log file
--log-level Log level (info, warning, error, critical)
--log-format Log format (plain, json-stream)
--quiet Suppress console output.
--profile Active project profile(s)
+``` + ## Commands -|Command |Description | -|:-------|:--------------------------------------------| -|`help` |Show this help or the help of a sub-command. | + +```{=html} + + + + + + + + + + + + + +
Command Description
<code>help</code> Show this help or the help of a sub-command.
+``` + diff --git a/docs/cli/includes/_dev-call-cli-info.md b/docs/cli/includes/_dev-call-cli-info.md index 3817fd45d5..99734f8098 100644 --- a/docs/cli/includes/_dev-call-cli-info.md +++ b/docs/cli/includes/_dev-call-cli-info.md @@ -7,20 +7,68 @@ quarto dev-call cli-info ## Options -|Flags |Arguments |Description | -|:--------------|:----------|:------------------------------------------| -|`-h`, `--help` | |Show this help. | -|`--log` |`` |Path to log file | -|`--log-level` |`` |Log level (info, warning, error, critical) | -|`--log-format` |`` |Log format (plain, json-stream) | -|`--quiet` | |Suppress console output. | + +```{=html} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Flags Arguments Description
-h, --help Show this help.
--log Path to log file
--log-level Log level (info, warning, error, critical)
--log-format Log format (plain, json-stream)
--quiet Suppress console output.
+``` + ## Commands -|Command |Description | -|:-------|:--------------------------------------------| -|`help` |Show this help or the help of a sub-command. | + +```{=html} + + + + + + + + + + + + + +
Command Description
<code>help</code> Show this help or the help of a sub-command.
+``` + diff --git a/docs/cli/includes/_dev-call.md b/docs/cli/includes/_dev-call.md index 5a8b75e773..ffacb5cd75 100644 --- a/docs/cli/includes/_dev-call.md +++ b/docs/cli/includes/_dev-call.md @@ -7,17 +7,52 @@ quarto dev-call ## Options -|Flags |Arguments |Description | -|:--------------|:---------|:---------------| -|`-h`, `--help` | |Show this help. | + +```{=html} + + + + + + + + + + + + + + + +
Flags Arguments Description
-h, --help Show this help.
+``` + ## Commands -|Command |Description | -|:----------|:-----------------------------------------------| -|`help` |Show this help or the help of a sub-command. | -|`cli-info` |Generate JSON information about the Quarto CLI. | + +```{=html} + + + + + + + + + + + + + + + + + +
Command Description
<code>help</code> Show this help or the help of a sub-command.
<code>cli-info</code> Generate JSON information about the Quarto CLI.
+``` + diff --git a/docs/cli/includes/_inspect.md b/docs/cli/includes/_inspect.md index 5389e8a2bc..abf1a44004 100644 --- a/docs/cli/includes/_inspect.md +++ b/docs/cli/includes/_inspect.md @@ -12,21 +12,73 @@ quarto inspect [path] [output] ## Options -|Flags |Arguments |Description | -|:--------------|:----------|:------------------------------------------| -|`-h`, `--help` | |Show this help. | -|`--log` |`` |Path to log file | -|`--log-level` |`` |Log level (info, warning, error, critical) | -|`--log-format` |`` |Log format (plain, json-stream) | -|`--quiet` | |Suppress console output. | -|`--profile` | |Active project profile(s) | + +```{=html} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Flags Arguments Description
-h, --help Show this help.
--log Path to log file
--log-level Log level (info, warning, error, critical)
--log-format Log format (plain, json-stream)
--quiet Suppress console output.
--profile Active project profile(s)
+``` + ## Commands -|Command |Description | -|:-------|:--------------------------------------------| -|`help` |Show this help or the help of a sub-command. | + +```{=html} + + + + + + + + + + + + + +
Command Description
<code>help</code> Show this help or the help of a sub-command.
+``` + ## Examples diff --git a/docs/cli/includes/_install.md b/docs/cli/includes/_install.md index 13cfdf21fe..470c04afd3 100644 --- a/docs/cli/includes/_install.md +++ b/docs/cli/includes/_install.md @@ -7,23 +7,83 @@ quarto install [target...] ## Options -|Flags |Arguments |Description | -|:---------------|:----------|:-------------------------------------------| -|`-h`, `--help` | |Show this help. | -|`--no-prompt` | |Do not prompt to confirm actions | -|`--update-path` | |Update system path when a tool is installed | -|`--log` |`` |Path to log file | -|`--log-level` |`` |Log level (info, warning, error, critical) | -|`--log-format` |`` |Log format (plain, json-stream) | -|`--quiet` | |Suppress console output. | -|`--profile` | |Active project profile(s) | + +```{=html} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Flags Arguments Description
-h, --help Show this help.
--no-prompt Do not prompt to confirm actions
--update-path Update system path when a tool is installed
--log Path to log file
--log-level Log level (info, warning, error, critical)
--log-format Log format (plain, json-stream)
--quiet Suppress console output.
--profile Active project profile(s)
+``` + ## Commands -|Command |Description | -|:-------|:--------------------------------------------| -|`help` |Show this help or the help of a sub-command. | + +```{=html} + + + + + + + + + + + + + +
Command Description
<code>help</code> Show this help or the help of a sub-command.
+``` + ## Examples diff --git a/docs/cli/includes/_list.md b/docs/cli/includes/_list.md index d074c33b8a..c844ea7e3a 100644 --- a/docs/cli/includes/_list.md +++ b/docs/cli/includes/_list.md @@ -7,21 +7,73 @@ quarto list ## Options -|Flags |Arguments |Description | -|:--------------|:----------|:------------------------------------------| -|`-h`, `--help` | |Show this help. | -|`--log` |`` |Path to log file | -|`--log-level` |`` |Log level (info, warning, error, critical) | -|`--log-format` |`` |Log format (plain, json-stream) | -|`--quiet` | |Suppress console output. | -|`--profile` | |Active project profile(s) | + +```{=html} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Flags Arguments Description
-h, --help Show this help.
--log Path to log file
--log-level Log level (info, warning, error, critical)
--log-format Log format (plain, json-stream)
--quiet Suppress console output.
--profile Active project profile(s)
+``` + ## Commands -|Command |Description | -|:-------|:--------------------------------------------| -|`help` |Show this help or the help of a sub-command. | + +```{=html} + + + + + + + + + + + + + +
Command Description
<code>help</code> Show this help or the help of a sub-command.
+``` + ## Examples diff --git a/docs/cli/includes/_pandoc.md b/docs/cli/includes/_pandoc.md index 76f241c6e8..d3933cfb87 100644 --- a/docs/cli/includes/_pandoc.md +++ b/docs/cli/includes/_pandoc.md @@ -10,21 +10,73 @@ quarto pandoc [...args] ## Options -|Flags |Arguments |Description | -|:--------------|:----------|:------------------------------------------| -|`-h`, `--help` | |Show this help. | -|`--log` |`` |Path to log file | -|`--log-level` |`` |Log level (info, warning, error, critical) | -|`--log-format` |`` |Log format (plain, json-stream) | -|`--quiet` | |Suppress console output. | -|`--profile` | |Active project profile(s) | + +```{=html} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Flags Arguments Description
-h, --help Show this help.
--log Path to log file
--log-level Log level (info, warning, error, critical)
--log-format Log format (plain, json-stream)
--quiet Suppress console output.
--profile Active project profile(s)
+``` + ## Commands -|Command |Description | -|:-------|:--------------------------------------------| -|`help` |Show this help or the help of a sub-command. | + +```{=html} + + + + + + + + + + + + + +
Command Description
<code>help</code> Show this help or the help of a sub-command.
+``` + ## Examples diff --git a/docs/cli/includes/_preview.md b/docs/cli/includes/_preview.md index 6d6738dec9..61559795b8 100644 --- a/docs/cli/includes/_preview.md +++ b/docs/cli/includes/_preview.md @@ -17,30 +17,114 @@ quarto preview [file:string] [...args:string] ## Options -|Flags |Arguments |Description | -|:-------------------|:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------| -|`-h`, `--help` | |Show this help. | -|`--port` |`[port:number]` |Suggested port to listen on (defaults to random value between 3000 and 8000). -If the port is not available then a random port between 3000 and 8000 will be selected. | -|`--host` |`[host:string]` |Hostname to bind to (defaults to 127.0.0.1) | -|`--render` |`[format:string]` |Render to the specified format(s) before previewing | -|`--no-serve` | |Don't run a local preview web server (just monitor and re-render input files) | -|`--no-navigate` | |Don't navigate the browser automatically when outputs are updated. | -|`--no-browser` | |Don't open a browser to preview the site. | -|`--no-watch-inputs` | |Do not re-render input files when they change. | -|`--timeout` | |Time (in seconds) after which to exit if there are no active clients. | -|`--log` |`` |Path to log file | -|`--log-level` |`` |Log level (info, warning, error, critical) | -|`--log-format` |`` |Log format (plain, json-stream) | -|`--quiet` | |Suppress console output. | -|`--profile` | |Active project profile(s) | + +```{=html} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Flags Arguments Description
-h, --help Show this help.
--port [port:number] Suggested port to listen on (defaults to random value between 3000 and 8000). +If the port is not available then a random port between 3000 and 8000 will be selected.
--host [host:string] Hostname to bind to (defaults to 127.0.0.1)
--render [format:string] Render to the specified format(s) before previewing
--no-serve Don't run a local preview web server (just monitor and re-render input files)
--no-navigate Don't navigate the browser automatically when outputs are updated.
--no-browser Don't open a browser to preview the site.
--no-watch-inputs Do not re-render input files when they change.
--timeout Time (in seconds) after which to exit if there are no active clients.
--log Path to log file
--log-level Log level (info, warning, error, critical)
--log-format Log format (plain, json-stream)
--quiet Suppress console output.
--profile Active project profile(s)
+``` + ## Commands -|Command |Description | -|:-------|:--------------------------------------------| -|`help` |Show this help or the help of a sub-command. | + +```{=html} + + + + + + + + + + + + + +
Command Description
<code>help</code> Show this help or the help of a sub-command.
+``` + ## Examples diff --git a/docs/cli/includes/_publish.md b/docs/cli/includes/_publish.md index b74f9cf1b7..9acdf5d151 100644 --- a/docs/cli/includes/_publish.md +++ b/docs/cli/includes/_publish.md @@ -20,27 +20,103 @@ quarto publish [provider] [path] ## Options -|Flags |Arguments |Description | -|:--------------|:-----------------|:--------------------------------------------------| -|`-h`, `--help` | |Show this help. | -|`--id` |`` |Identifier of content to publish | -|`--server` |`` |Server to publish to | -|`--token` |`` |Access token for publising provider | -|`--no-render` | |Do not render before publishing. | -|`--no-prompt` | |Do not prompt to confirm publishing destination | -|`--no-browser` | |Do not open a browser to the site after publishing | -|`--log` |`` |Path to log file | -|`--log-level` |`` |Log level (info, warning, error, critical) | -|`--log-format` |`` |Log format (plain, json-stream) | -|`--quiet` | |Suppress console output. | -|`--profile` | |Active project profile(s) | + +```{=html} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Flags Arguments Description
-h, --help Show this help.
--id Identifier of content to publish
--server Server to publish to
--token Access token for publising provider
--no-render Do not render before publishing.
--no-prompt Do not prompt to confirm publishing destination
--no-browser Do not open a browser to the site after publishing
--log Path to log file
--log-level Log level (info, warning, error, critical)
--log-format Log format (plain, json-stream)
--quiet Suppress console output.
--profile Active project profile(s)
+``` + ## Commands -|Command |Description | -|:-------|:--------------------------------------------| -|`help` |Show this help or the help of a sub-command. | + +```{=html} + + + + + + + + + + + + + +
Command Description
<code>help</code> Show this help or the help of a sub-command.
+``` + ## Examples diff --git a/docs/cli/includes/_remove.md b/docs/cli/includes/_remove.md index 4873d5c46b..5d17e62b36 100644 --- a/docs/cli/includes/_remove.md +++ b/docs/cli/includes/_remove.md @@ -7,23 +7,83 @@ quarto remove [target...] ## Options -|Flags |Arguments |Description | -|:--------------|:---------------|:-------------------------------------------------------------------------------------| -|`-h`, `--help` | |Show this help. | -|`--no-prompt` | |Do not prompt to confirm actions | -|`--embed` |`` |Remove this extension from within another extension (used when authoring extensions). | -|`--log` |`` |Path to log file | -|`--log-level` |`` |Log level (info, warning, error, critical) | -|`--log-format` |`` |Log format (plain, json-stream) | -|`--quiet` | |Suppress console output. | -|`--profile` | |Active project profile(s) | + +```{=html} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Flags Arguments Description
-h, --help Show this help.
--no-prompt Do not prompt to confirm actions
--embed Remove this extension from within another extension (used when authoring extensions).
--log Path to log file
--log-level Log level (info, warning, error, critical)
--log-format Log format (plain, json-stream)
--quiet Suppress console output.
--profile Active project profile(s)
+``` + ## Commands -|Command |Description | -|:-------|:--------------------------------------------| -|`help` |Show this help or the help of a sub-command. | + +```{=html} + + + + + + + + + + + + + +
Command Description
<code>help</code> Show this help or the help of a sub-command.
+``` + ## Examples diff --git a/docs/cli/includes/_render.md b/docs/cli/includes/_render.md index c07c04a1c9..e4212a9544 100644 --- a/docs/cli/includes/_render.md +++ b/docs/cli/includes/_render.md @@ -7,39 +7,163 @@ quarto render [input:string] [...args] ## Options -|Flags |Arguments |Description | -|:--------------------------|:----------|:----------------------------------------------------------------| -|`-h`, `--help` | |Show this help. | -|`-t`, `--to` | |Specify output format(s). | -|`-o`, `--output` | |Write output to FILE (use '--output -' for stdout). | -|`--output-dir` | |Write output to DIR (path is input/project relative) | -|`-M`, `--metadata` | |Metadata value (KEY:VALUE). | -|`--site-url` | |Override site-url for website or book output | -|`--execute` | |Execute code (--no-execute to skip execution). | -|`-P`, `--execute-param` | |Execution parameter (KEY:VALUE). | -|`--execute-params` | |YAML file with execution parameters. | -|`--execute-dir` | |Working directory for code execution. | -|`--execute-daemon` | |Keep Jupyter kernel alive (defaults to 300 seconds). | -|`--execute-daemon-restart` | |Restart keepalive Jupyter kernel before render. | -|`--execute-debug` | |Show debug output when executing computations. | -|`--use-freezer` | |Force use of frozen computations for an incremental file render. | -|`--cache` | |Cache execution output (--no-cache to prevent cache). | -|`--cache-refresh` | |Force refresh of execution cache. | -|`--no-clean` | |Do not clean project output-dir prior to render | -|`--debug` | |Leave intermediate files in place after render. | -|`pandoc-args...` | |Additional pandoc command line arguments. | -|`--log` |`` |Path to log file | -|`--log-level` |`` |Log level (info, warning, error, critical) | -|`--log-format` |`` |Log format (plain, json-stream) | -|`--quiet` | |Suppress console output. | -|`--profile` | |Active project profile(s) | + +```{=html} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Flags Arguments Description
-h, --help Show this help.
-t, --to Specify output format(s).
-o, --output Write output to FILE (use '--output -' for stdout).
--output-dir Write output to DIR (path is input/project relative)
-M, --metadata Metadata value (KEY:VALUE).
--site-url Override site-url for website or book output
--execute Execute code (--no-execute to skip execution).
-P, --execute-param Execution parameter (KEY:VALUE).
--execute-params YAML file with execution parameters.
--execute-dir Working directory for code execution.
--execute-daemon Keep Jupyter kernel alive (defaults to 300 seconds).
--execute-daemon-restart Restart keepalive Jupyter kernel before render.
--execute-debug Show debug output when executing computations.
--use-freezer Force use of frozen computations for an incremental file render.
--cache Cache execution output (--no-cache to prevent cache).
--cache-refresh Force refresh of execution cache.
--no-clean Do not clean project output-dir prior to render
--debug Leave intermediate files in place after render.
pandoc-args... Additional pandoc command line arguments.
--log Path to log file
--log-level Log level (info, warning, error, critical)
--log-format Log format (plain, json-stream)
--quiet Suppress console output.
--profile Active project profile(s)
+``` + ## Commands -|Command |Description | -|:-------|:--------------------------------------------| -|`help` |Show this help or the help of a sub-command. | + +```{=html} + + + + + + + + + + + + + +
Command Description
<code>help</code> Show this help or the help of a sub-command.
+``` + ## Examples diff --git a/docs/cli/includes/_run.md b/docs/cli/includes/_run.md index 1bc9ea83e7..016803de6c 100644 --- a/docs/cli/includes/_run.md +++ b/docs/cli/includes/_run.md @@ -10,21 +10,73 @@ quarto run [script:string] [...args] ## Options -|Flags |Arguments |Description | -|:--------------|:----------|:------------------------------------------| -|`-h`, `--help` | |Show this help. | -|`--log` |`` |Path to log file | -|`--log-level` |`` |Log level (info, warning, error, critical) | -|`--log-format` |`` |Log format (plain, json-stream) | -|`--quiet` | |Suppress console output. | -|`--profile` | |Active project profile(s) | + +```{=html} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Flags Arguments Description
-h, --help Show this help.
--log Path to log file
--log-level Log level (info, warning, error, critical)
--log-format Log format (plain, json-stream)
--quiet Suppress console output.
--profile Active project profile(s)
+``` + ## Commands -|Command |Description | -|:-------|:--------------------------------------------| -|`help` |Show this help or the help of a sub-command. | + +```{=html} + + + + + + + + + + + + + +
Command Description
<code>help</code> Show this help or the help of a sub-command.
+``` + diff --git a/docs/cli/includes/_serve.md b/docs/cli/includes/_serve.md index 4ab5b66b1c..752aacaeb3 100644 --- a/docs/cli/includes/_serve.md +++ b/docs/cli/includes/_serve.md @@ -9,25 +9,93 @@ quarto serve [input:string] ## Options -|Flags |Arguments |Description | -|:--------------|:---------------|:---------------------------------------------------| -|`-h`, `--help` | |Show this help. | -|`--no-render` | |Do not render the document before serving. | -|`-p`, `--port` |`[port:number]` |The TCP port that the application should listen on. | -|`--host` |`[host:string]` |Hostname to bind to (defaults to 127.0.0.1) | -|`--browser` | |Open a browser to preview the site. | -|`--log` |`` |Path to log file | -|`--log-level` |`` |Log level (info, warning, error, critical) | -|`--log-format` |`` |Log format (plain, json-stream) | -|`--quiet` | |Suppress console output. | -|`--profile` | |Active project profile(s) | + +```{=html} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Flags Arguments Description
-h, --help Show this help.
--no-render Do not render the document before serving.
-p, --port [port:number] The TCP port that the application should listen on.
--host [host:string] Hostname to bind to (defaults to 127.0.0.1)
--browser Open a browser to preview the site.
--log Path to log file
--log-level Log level (info, warning, error, critical)
--log-format Log format (plain, json-stream)
--quiet Suppress console output.
--profile Active project profile(s)
+``` + ## Commands -|Command |Description | -|:-------|:--------------------------------------------| -|`help` |Show this help or the help of a sub-command. | + +```{=html} + + + + + + + + + + + + + +
Command Description
<code>help</code> Show this help or the help of a sub-command.
+``` + ## Examples diff --git a/docs/cli/includes/_tools.md b/docs/cli/includes/_tools.md index 778e2ae619..8df14934c4 100644 --- a/docs/cli/includes/_tools.md +++ b/docs/cli/includes/_tools.md @@ -7,16 +7,48 @@ quarto tools ## Options -|Flags |Arguments |Description | -|:--------------|:---------|:---------------| -|`-h`, `--help` | |Show this help. | + +```{=html} + + + + + + + + + + + + + + + +
Flags Arguments Description
-h, --help Show this help.
+``` + ## Commands -|Command |Description | -|:-------|:--------------------------------------------| -|`help` |Show this help or the help of a sub-command. | + +```{=html} + + + + + + + + + + + + + +
Command Description
<code>help</code> Show this help or the help of a sub-command.
+``` + ## Examples diff --git a/docs/cli/includes/_typst.md b/docs/cli/includes/_typst.md index 07ee838158..633afda1d4 100644 --- a/docs/cli/includes/_typst.md +++ b/docs/cli/includes/_typst.md @@ -10,21 +10,73 @@ quarto typst [...args] ## Options -|Flags |Arguments |Description | -|:--------------|:----------|:------------------------------------------| -|`-h`, `--help` | |Show this help. | -|`--log` |`` |Path to log file | -|`--log-level` |`` |Log level (info, warning, error, critical) | -|`--log-format` |`` |Log format (plain, json-stream) | -|`--quiet` | |Suppress console output. | -|`--profile` | |Active project profile(s) | + +```{=html} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Flags Arguments Description
-h, --help Show this help.
--log Path to log file
--log-level Log level (info, warning, error, critical)
--log-format Log format (plain, json-stream)
--quiet Suppress console output.
--profile Active project profile(s)
+``` + ## Commands -|Command |Description | -|:-------|:--------------------------------------------| -|`help` |Show this help or the help of a sub-command. | + +```{=html} + + + + + + + + + + + + + +
Command Description
<code>help</code> Show this help or the help of a sub-command.
+``` + ## Examples diff --git a/docs/cli/includes/_uninstall.md b/docs/cli/includes/_uninstall.md index a9f52ecb58..a1ea973b47 100644 --- a/docs/cli/includes/_uninstall.md +++ b/docs/cli/includes/_uninstall.md @@ -7,23 +7,83 @@ quarto uninstall [tool] ## Options -|Flags |Arguments |Description | -|:---------------|:----------|:-------------------------------------------| -|`-h`, `--help` | |Show this help. | -|`--no-prompt` | |Do not prompt to confirm actions | -|`--update-path` | |Update system path when a tool is installed | -|`--log` |`` |Path to log file | -|`--log-level` |`` |Log level (info, warning, error, critical) | -|`--log-format` |`` |Log format (plain, json-stream) | -|`--quiet` | |Suppress console output. | -|`--profile` | |Active project profile(s) | + +```{=html} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Flags Arguments Description
-h, --help Show this help.
--no-prompt Do not prompt to confirm actions
--update-path Update system path when a tool is installed
--log Path to log file
--log-level Log level (info, warning, error, critical)
--log-format Log format (plain, json-stream)
--quiet Suppress console output.
--profile Active project profile(s)
+``` + ## Commands -|Command |Description | -|:-------|:--------------------------------------------| -|`help` |Show this help or the help of a sub-command. | + +```{=html} + + + + + + + + + + + + + +
Command Description
<code>help</code> Show this help or the help of a sub-command.
+``` + ## Examples diff --git a/docs/cli/includes/_update.md b/docs/cli/includes/_update.md index 79bcec98ca..d17e29fda2 100644 --- a/docs/cli/includes/_update.md +++ b/docs/cli/includes/_update.md @@ -7,23 +7,83 @@ quarto update [target...] ## Options -|Flags |Arguments |Description | -|:--------------|:---------------|:-------------------------------------------------------------------------------| -|`-h`, `--help` | |Show this help. | -|`--no-prompt` | |Do not prompt to confirm actions | -|`--embed` |`` |Embed this extension within another extension (used when authoring extensions). | -|`--log` |`` |Path to log file | -|`--log-level` |`` |Log level (info, warning, error, critical) | -|`--log-format` |`` |Log format (plain, json-stream) | -|`--quiet` | |Suppress console output. | -|`--profile` | |Active project profile(s) | + +```{=html} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Flags Arguments Description
-h, --help Show this help.
--no-prompt Do not prompt to confirm actions
--embed Embed this extension within another extension (used when authoring extensions).
--log Path to log file
--log-level Log level (info, warning, error, critical)
--log-format Log format (plain, json-stream)
--quiet Suppress console output.
--profile Active project profile(s)
+``` + ## Commands -|Command |Description | -|:-------|:--------------------------------------------| -|`help` |Show this help or the help of a sub-command. | + +```{=html} + + + + + + + + + + + + + +
Command Description
<code>help</code> Show this help or the help of a sub-command.
+``` + ## Examples diff --git a/docs/cli/includes/_use-binder.md b/docs/cli/includes/_use-binder.md index 3609c1be73..a30f631a3a 100644 --- a/docs/cli/includes/_use-binder.md +++ b/docs/cli/includes/_use-binder.md @@ -7,14 +7,51 @@ quarto use binder ## Options -|Flags |Arguments |Description | -|:--------------|:----------|:------------------------------------------| -|`--no-prompt` | |Do not prompt to confirm actions | -|`--log` |`` |Path to log file | -|`--log-level` |`` |Log level (info, warning, error, critical) | -|`--log-format` |`` |Log format (plain, json-stream) | -|`--quiet` | |Suppress console output. | -|`--profile` | |Active project profile(s) | + +```{=html} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Flags Arguments Description
--no-prompt Do not prompt to confirm actions
--log Path to log file
--log-level Log level (info, warning, error, critical)
--log-format Log format (plain, json-stream)
--quiet Suppress console output.
--profile Active project profile(s)
+``` + diff --git a/docs/cli/includes/_use-template.md b/docs/cli/includes/_use-template.md index ef7a605e16..2b188e6aa8 100644 --- a/docs/cli/includes/_use-template.md +++ b/docs/cli/includes/_use-template.md @@ -7,13 +7,46 @@ quarto use template ## Options -|Flags |Arguments |Description | -|:--------------|:----------|:------------------------------------------| -|`--no-prompt` | |Do not prompt to confirm actions | -|`--log` |`` |Path to log file | -|`--log-level` |`` |Log level (info, warning, error, critical) | -|`--log-format` |`` |Log format (plain, json-stream) | -|`--quiet` | |Suppress console output. | + +```{=html} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Flags Arguments Description
--no-prompt Do not prompt to confirm actions
--log Path to log file
--log-level Log level (info, warning, error, critical)
--log-format Log format (plain, json-stream)
--quiet Suppress console output.
+``` + diff --git a/docs/cli/includes/_use.md b/docs/cli/includes/_use.md index e032a4fe51..aefae5e514 100644 --- a/docs/cli/includes/_use.md +++ b/docs/cli/includes/_use.md @@ -7,17 +7,52 @@ quarto use [target:string] ## Options -|Flags |Arguments |Description | -|:-------------|:---------|:--------------------------------| -|`--no-prompt` | |Do not prompt to confirm actions | + +```{=html} + + + + + + + + + + + + + + + +
Flags Arguments Description
--no-prompt Do not prompt to confirm actions
+``` + ## Commands -|Command |Description | -|:----------|:----------------------------------------------------| -|`template` |Use a Quarto template for this directory or project. | -|`binder` |Configure the current project with Binder support. | + +```{=html} + + + + + + + + + + + + + + + + + +
Command Description
<code>template</code> Use a Quarto template for this directory or project.
<code>binder</code> Configure the current project with Binder support.
+``` + diff --git a/tools/reference-cli-generate-md.R b/tools/reference-cli-generate-md.R index 65e7085973..132e6158fc 100644 --- a/tools/reference-cli-generate-md.R +++ b/tools/reference-cli-generate-md.R @@ -9,6 +9,8 @@ library(knitr) library(here) library(tidyverse) +options(knitr.table.format = "html") + # Helper Functions ------------------------------------------------------- heading <- function(text, level = 2) { @@ -23,23 +25,30 @@ process_usage <- function(name, usage) { paste(collapse = "\n") } +make_code <- function(x) { + paste0("", x, "") +} + process_options <- function(options) { - tibble(options = options) |> + options_table <- tibble(options = options) |> unnest_wider(options) |> select(flags, typeDefinition, description) |> rowwise() |> mutate( - flags = paste0("`", flags, "`", collapse = ", "), + flags = paste0(make_code(flags), collapse = ", "), typeDefinition = ifelse( typeDefinition == "", "", - paste0("`", typeDefinition, "`") + paste0(make_code(typeDefinition)) ) ) |> knitr::kable( col.names = c("Flags", "Arguments", "Description"), + escape = FALSE ) |> paste(collapse = "\n") + + options_table |> raw_html() } process_commands <- function(commands) { @@ -48,13 +57,13 @@ process_commands <- function(commands) { } commands_table <- tibble(commands = commands) |> unnest_wider(commands) |> - mutate(name = paste0("`", name, "`")) |> + mutate(name = make_code(name)) |> select(name, description) |> knitr::kable( col.names = c("Command", "Description"), ) |> paste(collapse = "\n") - paste(heading("Commands", 2), commands_table, sep = "\n") + paste(heading("Commands", 2), raw_html(commands_table), sep = "\n") } process_examples <- function(examples) { From a162a4ed8f1405b913075a1b0c30d073f8c75e42 Mon Sep 17 00:00:00 2001 From: Charlotte Wickham Date: Thu, 8 May 2025 15:21:56 -0700 Subject: [PATCH 12/18] Escape commands table --- docs/cli/includes/_add.md | 2 +- docs/cli/includes/_call-engine-julia-close.md | 2 +- docs/cli/includes/_call-engine-julia-kill.md | 2 +- docs/cli/includes/_call-engine-julia-log.md | 2 +- docs/cli/includes/_call-engine-julia-status.md | 2 +- docs/cli/includes/_call-engine-julia-stop.md | 2 +- docs/cli/includes/_call-engine-julia.md | 12 ++++++------ docs/cli/includes/_call-engine.md | 4 ++-- docs/cli/includes/_call.md | 4 ++-- docs/cli/includes/_capabilities.md | 2 +- docs/cli/includes/_check.md | 6 ++---- docs/cli/includes/_convert.md | 2 +- docs/cli/includes/_create.md | 2 +- docs/cli/includes/_dev-call-cli-info.md | 2 +- docs/cli/includes/_dev-call.md | 4 ++-- docs/cli/includes/_inspect.md | 9 ++------- docs/cli/includes/_install.md | 2 +- docs/cli/includes/_list.md | 2 +- docs/cli/includes/_pandoc.md | 7 ++----- docs/cli/includes/_preview.md | 2 +- docs/cli/includes/_publish.md | 17 ++--------------- docs/cli/includes/_remove.md | 2 +- docs/cli/includes/_render.md | 2 +- docs/cli/includes/_run.md | 7 ++----- docs/cli/includes/_serve.md | 6 ++---- docs/cli/includes/_tools.md | 2 +- docs/cli/includes/_typst.md | 7 ++----- docs/cli/includes/_uninstall.md | 2 +- docs/cli/includes/_update.md | 2 +- docs/cli/includes/_use.md | 4 ++-- tools/reference-cli-generate-md.R | 1 + 31 files changed, 47 insertions(+), 77 deletions(-) diff --git a/docs/cli/includes/_add.md b/docs/cli/includes/_add.md index 47291ea3cd..20e307a82c 100644 --- a/docs/cli/includes/_add.md +++ b/docs/cli/includes/_add.md @@ -77,7 +77,7 @@ quarto add - <code>help</code> + help Show this help or the help of a sub-command. diff --git a/docs/cli/includes/_call-engine-julia-close.md b/docs/cli/includes/_call-engine-julia-close.md index 0198789e7a..9fa94a13d7 100644 --- a/docs/cli/includes/_call-engine-julia-close.md +++ b/docs/cli/includes/_call-engine-julia-close.md @@ -72,7 +72,7 @@ quarto call engine julia close - <code>help</code> + help Show this help or the help of a sub-command. diff --git a/docs/cli/includes/_call-engine-julia-kill.md b/docs/cli/includes/_call-engine-julia-kill.md index e6e0edb6bc..eece62d552 100644 --- a/docs/cli/includes/_call-engine-julia-kill.md +++ b/docs/cli/includes/_call-engine-julia-kill.md @@ -67,7 +67,7 @@ quarto call engine julia kill - <code>help</code> + help Show this help or the help of a sub-command. diff --git a/docs/cli/includes/_call-engine-julia-log.md b/docs/cli/includes/_call-engine-julia-log.md index b434200c43..bfa2ce8090 100644 --- a/docs/cli/includes/_call-engine-julia-log.md +++ b/docs/cli/includes/_call-engine-julia-log.md @@ -67,7 +67,7 @@ quarto call engine julia log - <code>help</code> + help Show this help or the help of a sub-command. diff --git a/docs/cli/includes/_call-engine-julia-status.md b/docs/cli/includes/_call-engine-julia-status.md index 5bc01864c0..8106158461 100644 --- a/docs/cli/includes/_call-engine-julia-status.md +++ b/docs/cli/includes/_call-engine-julia-status.md @@ -67,7 +67,7 @@ quarto call engine julia status - <code>help</code> + help Show this help or the help of a sub-command. diff --git a/docs/cli/includes/_call-engine-julia-stop.md b/docs/cli/includes/_call-engine-julia-stop.md index 66649066dc..7414a7d72b 100644 --- a/docs/cli/includes/_call-engine-julia-stop.md +++ b/docs/cli/includes/_call-engine-julia-stop.md @@ -67,7 +67,7 @@ quarto call engine julia stop - <code>help</code> + help Show this help or the help of a sub-command. diff --git a/docs/cli/includes/_call-engine-julia.md b/docs/cli/includes/_call-engine-julia.md index 74d12f7a69..d08c000fb8 100644 --- a/docs/cli/includes/_call-engine-julia.md +++ b/docs/cli/includes/_call-engine-julia.md @@ -67,27 +67,27 @@ quarto call engine julia - <code>help</code> + help Show this help or the help of a sub-command. - <code>status</code> + status Get status information on the currently running Julia server process. - <code>kill</code> + kill Kill the control server if it is currently running. This will also kill all notebook worker processes. - <code>log</code> + log Print the content of the julia server log file if it exists which can be used to diagnose problems. - <code>close</code> + close Close the worker for a given notebook. If it is currently running, it will not be interrupted. - <code>stop</code> + stop Send a message to the server that it should close all notebooks and exit. This will fail if any notebooks are not idle. diff --git a/docs/cli/includes/_call-engine.md b/docs/cli/includes/_call-engine.md index 69bdbacd00..253d281c64 100644 --- a/docs/cli/includes/_call-engine.md +++ b/docs/cli/includes/_call-engine.md @@ -67,11 +67,11 @@ quarto call engine - <code>help</code> + help Show this help or the help of a sub-command. - <code>julia</code> + julia Access functionality specific to the julia rendering engine. diff --git a/docs/cli/includes/_call.md b/docs/cli/includes/_call.md index b0471061eb..47865ac6e4 100644 --- a/docs/cli/includes/_call.md +++ b/docs/cli/includes/_call.md @@ -42,11 +42,11 @@ quarto call - <code>help</code> + help Show this help or the help of a sub-command. - <code>engine</code> + engine Access functionality specific to quarto's different rendering engines. diff --git a/docs/cli/includes/_capabilities.md b/docs/cli/includes/_capabilities.md index 5507955e53..df5d8fcf66 100644 --- a/docs/cli/includes/_capabilities.md +++ b/docs/cli/includes/_capabilities.md @@ -67,7 +67,7 @@ quarto capabilities - <code>help</code> + help Show this help or the help of a sub-command. diff --git a/docs/cli/includes/_check.md b/docs/cli/includes/_check.md index 01425502fd..2ae9f30b84 100644 --- a/docs/cli/includes/_check.md +++ b/docs/cli/includes/_check.md @@ -1,6 +1,4 @@ -Verify correct functioning of Quarto installation. - -Check specific functionality with argument install, jupyter, knitr, or all. +Verify correct functioning of Quarto installation.Check specific functionality with argument install, jupyter, knitr, or all. ``` {.bash} quarto check [target:string] @@ -79,7 +77,7 @@ quarto check [target:string] - <code>help</code> + help Show this help or the help of a sub-command. diff --git a/docs/cli/includes/_convert.md b/docs/cli/includes/_convert.md index 328b2c2b41..cb64259c3b 100644 --- a/docs/cli/includes/_convert.md +++ b/docs/cli/includes/_convert.md @@ -77,7 +77,7 @@ quarto convert - <code>help</code> + help Show this help or the help of a sub-command. diff --git a/docs/cli/includes/_create.md b/docs/cli/includes/_create.md index 756793605f..3c45823768 100644 --- a/docs/cli/includes/_create.md +++ b/docs/cli/includes/_create.md @@ -82,7 +82,7 @@ quarto create [type] [commands...] - <code>help</code> + help Show this help or the help of a sub-command. diff --git a/docs/cli/includes/_dev-call-cli-info.md b/docs/cli/includes/_dev-call-cli-info.md index 99734f8098..06fa2f13da 100644 --- a/docs/cli/includes/_dev-call-cli-info.md +++ b/docs/cli/includes/_dev-call-cli-info.md @@ -62,7 +62,7 @@ quarto dev-call cli-info - <code>help</code> + help Show this help or the help of a sub-command. diff --git a/docs/cli/includes/_dev-call.md b/docs/cli/includes/_dev-call.md index ffacb5cd75..c6be51d0d1 100644 --- a/docs/cli/includes/_dev-call.md +++ b/docs/cli/includes/_dev-call.md @@ -42,11 +42,11 @@ quarto dev-call - <code>help</code> + help Show this help or the help of a sub-command. - <code>cli-info</code> + cli-info Generate JSON information about the Quarto CLI. diff --git a/docs/cli/includes/_inspect.md b/docs/cli/includes/_inspect.md index abf1a44004..64f649ef37 100644 --- a/docs/cli/includes/_inspect.md +++ b/docs/cli/includes/_inspect.md @@ -1,9 +1,4 @@ -Inspect a Quarto project or input path. - -Inspecting a project returns its config and engines. -Inspecting an input path return its formats, engine, and dependent resources. - -Emits results of inspection as JSON to output (or stdout if not provided). +Inspect a Quarto project or input path.Inspecting a project returns its config and engines.Inspecting an input path return its formats, engine, and dependent resources.Emits results of inspection as JSON to output (or stdout if not provided). ``` {.bash} quarto inspect [path] [output] @@ -72,7 +67,7 @@ quarto inspect [path] [output] - <code>help</code> + help Show this help or the help of a sub-command. diff --git a/docs/cli/includes/_install.md b/docs/cli/includes/_install.md index 470c04afd3..66ccca495b 100644 --- a/docs/cli/includes/_install.md +++ b/docs/cli/includes/_install.md @@ -77,7 +77,7 @@ quarto install [target...] - <code>help</code> + help Show this help or the help of a sub-command. diff --git a/docs/cli/includes/_list.md b/docs/cli/includes/_list.md index c844ea7e3a..3592931437 100644 --- a/docs/cli/includes/_list.md +++ b/docs/cli/includes/_list.md @@ -67,7 +67,7 @@ quarto list - <code>help</code> + help Show this help or the help of a sub-command. diff --git a/docs/cli/includes/_pandoc.md b/docs/cli/includes/_pandoc.md index d3933cfb87..a9880dcb80 100644 --- a/docs/cli/includes/_pandoc.md +++ b/docs/cli/includes/_pandoc.md @@ -1,7 +1,4 @@ -Run the version of Pandoc embedded within Quarto. - -You can pass arbitrary command line arguments to quarto pandoc (they will -be passed through unmodified to Pandoc) +Run the version of Pandoc embedded within Quarto.You can pass arbitrary command line arguments to quarto pandoc (they willbe passed through unmodified to Pandoc) ``` {.bash} quarto pandoc [...args] @@ -70,7 +67,7 @@ quarto pandoc [...args] - <code>help</code> + help Show this help or the help of a sub-command. diff --git a/docs/cli/includes/_preview.md b/docs/cli/includes/_preview.md index 61559795b8..9f157d2271 100644 --- a/docs/cli/includes/_preview.md +++ b/docs/cli/includes/_preview.md @@ -118,7 +118,7 @@ If the port is not available then a random port between 3000 and 8000 will be se - <code>help</code> + help Show this help or the help of a sub-command. diff --git a/docs/cli/includes/_publish.md b/docs/cli/includes/_publish.md index 9acdf5d151..bb9a71b184 100644 --- a/docs/cli/includes/_publish.md +++ b/docs/cli/includes/_publish.md @@ -1,17 +1,4 @@ -Publish a document or project to a provider. - -Available providers include: - - - Quarto Pub (quarto-pub) - - GitHub Pages (gh-pages) - - Posit Connect (connect) - - Posit Cloud (posit-cloud) - - Netlify (netlify) - - Confluence (confluence) - - Hugging Face Spaces (huggingface) - -Accounts are configured interactively during publishing. -Manage/remove accounts with: quarto publish accounts +Publish a document or project to a provider.Available providers include: - Quarto Pub (quarto-pub) - GitHub Pages (gh-pages) - Posit Connect (connect) - Posit Cloud (posit-cloud) - Netlify (netlify) - Confluence (confluence) - Hugging Face Spaces (huggingface)Accounts are configured interactively during publishing.Manage/remove accounts with: quarto publish accounts ``` {.bash} quarto publish [provider] [path] @@ -110,7 +97,7 @@ quarto publish [provider] [path] - <code>help</code> + help Show this help or the help of a sub-command. diff --git a/docs/cli/includes/_remove.md b/docs/cli/includes/_remove.md index 5d17e62b36..6516c38ced 100644 --- a/docs/cli/includes/_remove.md +++ b/docs/cli/includes/_remove.md @@ -77,7 +77,7 @@ quarto remove [target...] - <code>help</code> + help Show this help or the help of a sub-command. diff --git a/docs/cli/includes/_render.md b/docs/cli/includes/_render.md index e4212a9544..272bfbc36c 100644 --- a/docs/cli/includes/_render.md +++ b/docs/cli/includes/_render.md @@ -157,7 +157,7 @@ quarto render [input:string] [...args] - <code>help</code> + help Show this help or the help of a sub-command. diff --git a/docs/cli/includes/_run.md b/docs/cli/includes/_run.md index 016803de6c..29ae2c432f 100644 --- a/docs/cli/includes/_run.md +++ b/docs/cli/includes/_run.md @@ -1,7 +1,4 @@ -Run a TypeScript, R, Python, or Lua script. - -Run a utility script written in a variety of languages. For details, see: -https://quarto.org/docs/projects/scripts.html#periodic-scripts +Run a TypeScript, R, Python, or Lua script.Run a utility script written in a variety of languages. For details, see:https://quarto.org/docs/projects/scripts.html#periodic-scripts ``` {.bash} quarto run [script:string] [...args] @@ -70,7 +67,7 @@ quarto run [script:string] [...args] - <code>help</code> + help Show this help or the help of a sub-command. diff --git a/docs/cli/includes/_serve.md b/docs/cli/includes/_serve.md index 752aacaeb3..f02bdce1d6 100644 --- a/docs/cli/includes/_serve.md +++ b/docs/cli/includes/_serve.md @@ -1,6 +1,4 @@ -Serve a Shiny interactive document. - -By default, the document will be rendered first and then served. If you have previously rendered the document, pass --no-render to skip the rendering step. +Serve a Shiny interactive document.By default, the document will be rendered first and then served. If you have previously rendered the document, pass --no-render to skip the rendering step. ``` {.bash} quarto serve [input:string] @@ -89,7 +87,7 @@ quarto serve [input:string] - <code>help</code> + help Show this help or the help of a sub-command. diff --git a/docs/cli/includes/_tools.md b/docs/cli/includes/_tools.md index 8df14934c4..3a2fc2f915 100644 --- a/docs/cli/includes/_tools.md +++ b/docs/cli/includes/_tools.md @@ -42,7 +42,7 @@ quarto tools - <code>help</code> + help Show this help or the help of a sub-command. diff --git a/docs/cli/includes/_typst.md b/docs/cli/includes/_typst.md index 633afda1d4..59964d1a20 100644 --- a/docs/cli/includes/_typst.md +++ b/docs/cli/includes/_typst.md @@ -1,7 +1,4 @@ -Run the version of Typst embedded within Quarto. - -You can pass arbitrary command line arguments to quarto typst (they will -be passed through unmodified to Typst) +Run the version of Typst embedded within Quarto.You can pass arbitrary command line arguments to quarto typst (they willbe passed through unmodified to Typst) ``` {.bash} quarto typst [...args] @@ -70,7 +67,7 @@ quarto typst [...args] - <code>help</code> + help Show this help or the help of a sub-command. diff --git a/docs/cli/includes/_uninstall.md b/docs/cli/includes/_uninstall.md index a1ea973b47..97bc645160 100644 --- a/docs/cli/includes/_uninstall.md +++ b/docs/cli/includes/_uninstall.md @@ -77,7 +77,7 @@ quarto uninstall [tool] - <code>help</code> + help Show this help or the help of a sub-command. diff --git a/docs/cli/includes/_update.md b/docs/cli/includes/_update.md index d17e29fda2..cb78f32f23 100644 --- a/docs/cli/includes/_update.md +++ b/docs/cli/includes/_update.md @@ -77,7 +77,7 @@ quarto update [target...] - <code>help</code> + help Show this help or the help of a sub-command. diff --git a/docs/cli/includes/_use.md b/docs/cli/includes/_use.md index aefae5e514..e61061e25a 100644 --- a/docs/cli/includes/_use.md +++ b/docs/cli/includes/_use.md @@ -42,11 +42,11 @@ quarto use [target:string] - <code>template</code> + template Use a Quarto template for this directory or project. - <code>binder</code> + binder Configure the current project with Binder support. diff --git a/tools/reference-cli-generate-md.R b/tools/reference-cli-generate-md.R index 132e6158fc..071e5161ac 100644 --- a/tools/reference-cli-generate-md.R +++ b/tools/reference-cli-generate-md.R @@ -61,6 +61,7 @@ process_commands <- function(commands) { select(name, description) |> knitr::kable( col.names = c("Command", "Description"), + escape = FALSE ) |> paste(collapse = "\n") paste(heading("Commands", 2), raw_html(commands_table), sep = "\n") From d16432331a1e576c364c8dc2dd499ed122604f8b Mon Sep 17 00:00:00 2001 From: Charlotte Wickham Date: Thu, 8 May 2025 15:22:11 -0700 Subject: [PATCH 13/18] Escape ANSI in description --- docs/cli/includes/_preview.md | 12 +----------- tools/reference-cli-generate-md.R | 3 ++- 2 files changed, 3 insertions(+), 12 deletions(-) diff --git a/docs/cli/includes/_preview.md b/docs/cli/includes/_preview.md index 9f157d2271..e7c6df6928 100644 --- a/docs/cli/includes/_preview.md +++ b/docs/cli/includes/_preview.md @@ -1,14 +1,4 @@ -Render and preview a document or website project. - -Automatically reloads the browser when input files or document resources (e.g. CSS) change. - -For website preview, the most recent execution results of computational documents are used to render -the site (this is to optimize startup time). If you want to perform a full render prior to -previewing pass the --render option with "all" or a comma-separated list of formats to render. - -For document preview, input file changes will result in a re-render (pass --no-watch to prevent). - -You can also include arbitrary command line arguments to be forwarded to quarto render. +Render and preview a document or website project.Automatically reloads the browser when input files or document resources (e.g. CSS) change.For website preview, the most recent execution results of computational documents are used to renderthe site (this is to optimize startup time). If you want to perform a full render prior topreviewing pass the --render option with "all" or a comma-separated list of formats to render.For document preview, input file changes will result in a re-render (pass --no-watch to prevent).You can also include arbitrary command line arguments to be forwarded to quarto render. ``` {.bash} quarto preview [file:string] [...args:string] diff --git a/tools/reference-cli-generate-md.R b/tools/reference-cli-generate-md.R index 071e5161ac..0c9ee0c635 100644 --- a/tools/reference-cli-generate-md.R +++ b/tools/reference-cli-generate-md.R @@ -8,6 +8,7 @@ library(jsonlite) library(knitr) library(here) library(tidyverse) +library(fansi) options(knitr.table.format = "html") @@ -97,7 +98,7 @@ md_content <- function(name, description, usage, options, commands, examples) { examples_text <- process_examples(examples) paste( - description, + strip_ctl(description), usage_text, "\n", heading("Options"), From d69c1d6b18292c746f78a8120f011f7f9624ac77 Mon Sep 17 00:00:00 2001 From: Charlotte Wickham Date: Thu, 8 May 2025 15:27:50 -0700 Subject: [PATCH 14/18] Roll back over zelaous escaping --- docs/cli/includes/_check.md | 4 +++- docs/cli/includes/_inspect.md | 7 ++++++- docs/cli/includes/_pandoc.md | 5 ++++- docs/cli/includes/_preview.md | 12 +++++++++++- docs/cli/includes/_publish.md | 15 ++++++++++++++- docs/cli/includes/_run.md | 5 ++++- docs/cli/includes/_serve.md | 4 +++- docs/cli/includes/_typst.md | 5 ++++- tools/reference-cli-generate-md.R | 2 +- 9 files changed, 50 insertions(+), 9 deletions(-) diff --git a/docs/cli/includes/_check.md b/docs/cli/includes/_check.md index 2ae9f30b84..3be6c65f07 100644 --- a/docs/cli/includes/_check.md +++ b/docs/cli/includes/_check.md @@ -1,4 +1,6 @@ -Verify correct functioning of Quarto installation.Check specific functionality with argument install, jupyter, knitr, or all. +Verify correct functioning of Quarto installation. + +Check specific functionality with argument install, jupyter, knitr, or all. ``` {.bash} quarto check [target:string] diff --git a/docs/cli/includes/_inspect.md b/docs/cli/includes/_inspect.md index 64f649ef37..e28a5129da 100644 --- a/docs/cli/includes/_inspect.md +++ b/docs/cli/includes/_inspect.md @@ -1,4 +1,9 @@ -Inspect a Quarto project or input path.Inspecting a project returns its config and engines.Inspecting an input path return its formats, engine, and dependent resources.Emits results of inspection as JSON to output (or stdout if not provided). +Inspect a Quarto project or input path. + +Inspecting a project returns its config and engines. +Inspecting an input path return its formats, engine, and dependent resources. + +Emits results of inspection as JSON to output (or stdout if not provided). ``` {.bash} quarto inspect [path] [output] diff --git a/docs/cli/includes/_pandoc.md b/docs/cli/includes/_pandoc.md index a9880dcb80..dd27e301d7 100644 --- a/docs/cli/includes/_pandoc.md +++ b/docs/cli/includes/_pandoc.md @@ -1,4 +1,7 @@ -Run the version of Pandoc embedded within Quarto.You can pass arbitrary command line arguments to quarto pandoc (they willbe passed through unmodified to Pandoc) +Run the version of Pandoc embedded within Quarto. + +You can pass arbitrary command line arguments to quarto pandoc (they will +be passed through unmodified to Pandoc) ``` {.bash} quarto pandoc [...args] diff --git a/docs/cli/includes/_preview.md b/docs/cli/includes/_preview.md index e7c6df6928..9f157d2271 100644 --- a/docs/cli/includes/_preview.md +++ b/docs/cli/includes/_preview.md @@ -1,4 +1,14 @@ -Render and preview a document or website project.Automatically reloads the browser when input files or document resources (e.g. CSS) change.For website preview, the most recent execution results of computational documents are used to renderthe site (this is to optimize startup time). If you want to perform a full render prior topreviewing pass the --render option with "all" or a comma-separated list of formats to render.For document preview, input file changes will result in a re-render (pass --no-watch to prevent).You can also include arbitrary command line arguments to be forwarded to quarto render. +Render and preview a document or website project. + +Automatically reloads the browser when input files or document resources (e.g. CSS) change. + +For website preview, the most recent execution results of computational documents are used to render +the site (this is to optimize startup time). If you want to perform a full render prior to +previewing pass the --render option with "all" or a comma-separated list of formats to render. + +For document preview, input file changes will result in a re-render (pass --no-watch to prevent). + +You can also include arbitrary command line arguments to be forwarded to quarto render. ``` {.bash} quarto preview [file:string] [...args:string] diff --git a/docs/cli/includes/_publish.md b/docs/cli/includes/_publish.md index bb9a71b184..58be092f48 100644 --- a/docs/cli/includes/_publish.md +++ b/docs/cli/includes/_publish.md @@ -1,4 +1,17 @@ -Publish a document or project to a provider.Available providers include: - Quarto Pub (quarto-pub) - GitHub Pages (gh-pages) - Posit Connect (connect) - Posit Cloud (posit-cloud) - Netlify (netlify) - Confluence (confluence) - Hugging Face Spaces (huggingface)Accounts are configured interactively during publishing.Manage/remove accounts with: quarto publish accounts +Publish a document or project to a provider. + +Available providers include: + + - Quarto Pub (quarto-pub) + - GitHub Pages (gh-pages) + - Posit Connect (connect) + - Posit Cloud (posit-cloud) + - Netlify (netlify) + - Confluence (confluence) + - Hugging Face Spaces (huggingface) + +Accounts are configured interactively during publishing. +Manage/remove accounts with: quarto publish accounts ``` {.bash} quarto publish [provider] [path] diff --git a/docs/cli/includes/_run.md b/docs/cli/includes/_run.md index 29ae2c432f..9f5e938ab3 100644 --- a/docs/cli/includes/_run.md +++ b/docs/cli/includes/_run.md @@ -1,4 +1,7 @@ -Run a TypeScript, R, Python, or Lua script.Run a utility script written in a variety of languages. For details, see:https://quarto.org/docs/projects/scripts.html#periodic-scripts +Run a TypeScript, R, Python, or Lua script. + +Run a utility script written in a variety of languages. For details, see: +https://quarto.org/docs/projects/scripts.html#periodic-scripts ``` {.bash} quarto run [script:string] [...args] diff --git a/docs/cli/includes/_serve.md b/docs/cli/includes/_serve.md index f02bdce1d6..f0b626c3f0 100644 --- a/docs/cli/includes/_serve.md +++ b/docs/cli/includes/_serve.md @@ -1,4 +1,6 @@ -Serve a Shiny interactive document.By default, the document will be rendered first and then served. If you have previously rendered the document, pass --no-render to skip the rendering step. +Serve a Shiny interactive document. + +By default, the document will be rendered first and then served. If you have previously rendered the document, pass --no-render to skip the rendering step. ``` {.bash} quarto serve [input:string] diff --git a/docs/cli/includes/_typst.md b/docs/cli/includes/_typst.md index 59964d1a20..59fa383699 100644 --- a/docs/cli/includes/_typst.md +++ b/docs/cli/includes/_typst.md @@ -1,4 +1,7 @@ -Run the version of Typst embedded within Quarto.You can pass arbitrary command line arguments to quarto typst (they willbe passed through unmodified to Typst) +Run the version of Typst embedded within Quarto. + +You can pass arbitrary command line arguments to quarto typst (they will +be passed through unmodified to Typst) ``` {.bash} quarto typst [...args] diff --git a/tools/reference-cli-generate-md.R b/tools/reference-cli-generate-md.R index 0c9ee0c635..3475f56bda 100644 --- a/tools/reference-cli-generate-md.R +++ b/tools/reference-cli-generate-md.R @@ -98,7 +98,7 @@ md_content <- function(name, description, usage, options, commands, examples) { examples_text <- process_examples(examples) paste( - strip_ctl(description), + description, usage_text, "\n", heading("Options"), From fe0e2cdc77ad070b177078da211591291c291097 Mon Sep 17 00:00:00 2001 From: Charlotte Wickham Date: Thu, 8 May 2025 15:29:05 -0700 Subject: [PATCH 15/18] Strip just ANSI codes --- docs/cli/includes/_preview.md | 2 +- tools/reference-cli-generate-md.R | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/cli/includes/_preview.md b/docs/cli/includes/_preview.md index 9f157d2271..2f6fb025a2 100644 --- a/docs/cli/includes/_preview.md +++ b/docs/cli/includes/_preview.md @@ -8,7 +8,7 @@ previewing pass the --render option with "all" or a comma-separated list of form For document preview, input file changes will result in a re-render (pass --no-watch to prevent). -You can also include arbitrary command line arguments to be forwarded to quarto render. +You can also include arbitrary command line arguments to be forwarded to quarto render. ``` {.bash} quarto preview [file:string] [...args:string] diff --git a/tools/reference-cli-generate-md.R b/tools/reference-cli-generate-md.R index 3475f56bda..a676d2336b 100644 --- a/tools/reference-cli-generate-md.R +++ b/tools/reference-cli-generate-md.R @@ -98,7 +98,7 @@ md_content <- function(name, description, usage, options, commands, examples) { examples_text <- process_examples(examples) paste( - description, + strip_ctl(description, ctl = "sgr"), usage_text, "\n", heading("Options"), From 3d60d7a3bf741716bb8acfd3f6e04f637158b7fa Mon Sep 17 00:00:00 2001 From: Charlotte Wickham Date: Thu, 8 May 2025 15:52:43 -0700 Subject: [PATCH 16/18] Stick to pipe table for landing --- docs/cli/includes/_cli-commands.md | 122 ++++++----------------------- tools/reference-cli-generate-md.R | 2 +- 2 files changed, 25 insertions(+), 99 deletions(-) diff --git a/docs/cli/includes/_cli-commands.md b/docs/cli/includes/_cli-commands.md index 54d834c906..941b06a881 100644 --- a/docs/cli/includes/_cli-commands.md +++ b/docs/cli/includes/_cli-commands.md @@ -1,98 +1,24 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
name description
[render](render.qmd) Render files or projects to various document types.
[preview](preview.qmd) Render and preview a document or website project.
[serve](serve.qmd) Serve a Shiny interactive document.
[create](create.qmd) Create a Quarto project or extension
[use](use.qmd) Automate document or project setup tasks.
[add](add.qmd) Add an extension to this folder or project
[update](update.qmd) Updates an extension or global dependency.
[remove](remove.qmd) Removes an extension.
[convert](convert.qmd) Convert documents to alternate representations.
[pandoc](pandoc.qmd) Run the version of Pandoc embedded within Quarto.
[typst](typst.qmd) Run the version of Typst embedded within Quarto.
[run](run.qmd) Run a TypeScript, R, Python, or Lua script.
[list](list.qmd) Lists an extension or global dependency.
[install](install.qmd) Installs a global dependency (TinyTex or Chromium).
[uninstall](uninstall.qmd) Removes an extension.
[tools](tools.qmd) Display the status of Quarto installed dependencies
[publish](publish.qmd) Publish a document or project to a provider.
[capabilities](capabilities.qmd) Query for current capabilities (formats, engines, kernels etc.)
[inspect](inspect.qmd) Inspect a Quarto project or input path.
[check](check.qmd) Verify correct functioning of Quarto installation.
[call](call.qmd) Access functions of Quarto subsystems such as its rendering engines.
[dev-call](dev-call.qmd) Access internals of Quarto - this command is not intended for general use.
+|Command |Description | +|:------------|:--------------------------------------------------------------------------| +|[render](render.qmd)|Render files or projects to various document types. | +|[preview](preview.qmd)|Render and preview a document or website project. | +|[serve](serve.qmd)|Serve a Shiny interactive document. | +|[create](create.qmd)|Create a Quarto project or extension | +|[use](use.qmd)|Automate document or project setup tasks. | +|[add](add.qmd)|Add an extension to this folder or project | +|[update](update.qmd)|Updates an extension or global dependency. | +|[remove](remove.qmd)|Removes an extension. | +|[convert](convert.qmd)|Convert documents to alternate representations. | +|[pandoc](pandoc.qmd)|Run the version of Pandoc embedded within Quarto. | +|[typst](typst.qmd)|Run the version of Typst embedded within Quarto. | +|[run](run.qmd)|Run a TypeScript, R, Python, or Lua script. | +|[list](list.qmd)|Lists an extension or global dependency. | +|[install](install.qmd)|Installs a global dependency (TinyTex or Chromium). | +|[uninstall](uninstall.qmd)|Removes an extension. | +|[tools](tools.qmd)|Display the status of Quarto installed dependencies | +|[publish](publish.qmd)|Publish a document or project to a provider. | +|[capabilities](capabilities.qmd)|Query for current capabilities (formats, engines, kernels etc.) | +|[inspect](inspect.qmd)|Inspect a Quarto project or input path. | +|[check](check.qmd)|Verify correct functioning of Quarto installation. | +|[call](call.qmd)|Access functions of Quarto subsystems such as its rendering engines. | +|[dev-call](dev-call.qmd)|Access internals of Quarto - this command is not intended for general use. | diff --git a/tools/reference-cli-generate-md.R b/tools/reference-cli-generate-md.R index a676d2336b..bb3778ac15 100644 --- a/tools/reference-cli-generate-md.R +++ b/tools/reference-cli-generate-md.R @@ -153,7 +153,7 @@ tibble(commands = commands) |> name = paste("[", name, "](", name, ".qmd)", sep = ""), description = stringr::str_extract(description, "^[^\\n]+") ) |> - knitr::kable() |> + knitr::kable(col.names = c("Command", "Description"), format = "pipe") |> writeLines(here("docs", "cli", "includes", "_cli-commands.md")) From 46c8f0f2b4298ecc5062e41dbcc576cd303e09a0 Mon Sep 17 00:00:00 2001 From: Carlos Scheidegger Date: Fri, 9 May 2025 15:09:36 -0400 Subject: [PATCH 17/18] add hidden field --- docs/cli/cli-info.json | 69 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 68 insertions(+), 1 deletion(-) diff --git a/docs/cli/cli-info.json b/docs/cli/cli-info.json index 45babcd6f6..47fc29483a 100644 --- a/docs/cli/cli-info.json +++ b/docs/cli/cli-info.json @@ -1,8 +1,9 @@ { - "version": "1.8.3", + "version": "99.9.9", "commands": [ { "name": "render", + "hidden": false, "description": "Render files or projects to various document types.", "options": [ { @@ -330,6 +331,7 @@ "commands": [ { "name": "help", + "hidden": false, "description": "Show this help or the help of a sub-command.", "options": [ { @@ -358,6 +360,7 @@ }, { "name": "preview", + "hidden": false, "description": "Render and preview a document or website project.\n\nAutomatically reloads the browser when input files or document resources (e.g. CSS) change.\n\nFor website preview, the most recent execution results of computational documents are used to render\nthe site (this is to optimize startup time). If you want to perform a full render prior to\npreviewing pass the --render option with \"all\" or a comma-separated list of formats to render.\n\nFor document preview, input file changes will result in a re-render (pass --no-watch to prevent).\n\nYou can also include arbitrary command line arguments to be forwarded to \u001b[1mquarto render\u001b[22m.", "options": [ { @@ -606,6 +609,7 @@ "commands": [ { "name": "help", + "hidden": false, "description": "Show this help or the help of a sub-command.", "options": [ { @@ -634,6 +638,7 @@ }, { "name": "serve", + "hidden": false, "description": "Serve a Shiny interactive document.\n\nBy default, the document will be rendered first and then served. If you have previously rendered the document, pass --no-render to skip the rendering step.", "options": [ { @@ -812,6 +817,7 @@ "commands": [ { "name": "help", + "hidden": false, "description": "Show this help or the help of a sub-command.", "options": [ { @@ -840,6 +846,7 @@ }, { "name": "create", + "hidden": false, "description": "Create a Quarto project or extension", "options": [ { @@ -986,6 +993,7 @@ "commands": [ { "name": "help", + "hidden": false, "description": "Show this help or the help of a sub-command.", "options": [ { @@ -1014,6 +1022,7 @@ }, { "name": "use", + "hidden": false, "description": "Automate document or project setup tasks.", "options": [ { @@ -1032,6 +1041,7 @@ "commands": [ { "name": "template", + "hidden": false, "description": "Use a Quarto template for this directory or project.", "options": [ { @@ -1127,6 +1137,7 @@ }, { "name": "binder", + "hidden": false, "description": "Configure the current project with Binder support.", "options": [ { @@ -1235,6 +1246,7 @@ }, { "name": "add", + "hidden": false, "description": "Add an extension to this folder or project", "options": [ { @@ -1384,6 +1396,7 @@ "commands": [ { "name": "help", + "hidden": false, "description": "Show this help or the help of a sub-command.", "options": [ { @@ -1412,6 +1425,7 @@ }, { "name": "update", + "hidden": false, "description": "Updates an extension or global dependency.", "options": [ { @@ -1573,6 +1587,7 @@ "commands": [ { "name": "help", + "hidden": false, "description": "Show this help or the help of a sub-command.", "options": [ { @@ -1601,6 +1616,7 @@ }, { "name": "remove", + "hidden": false, "description": "Removes an extension.", "options": [ { @@ -1742,6 +1758,7 @@ "commands": [ { "name": "help", + "hidden": false, "description": "Show this help or the help of a sub-command.", "options": [ { @@ -1770,6 +1787,7 @@ }, { "name": "create-project", + "hidden": true, "description": "Create a project for rendering multiple documents", "options": [ { @@ -2069,6 +2087,7 @@ "commands": [ { "name": "help", + "hidden": false, "description": "Show this help or the help of a sub-command.", "options": [ { @@ -2097,6 +2116,7 @@ }, { "name": "convert", + "hidden": false, "description": "Convert documents to alternate representations.", "options": [ { @@ -2250,6 +2270,7 @@ "commands": [ { "name": "help", + "hidden": false, "description": "Show this help or the help of a sub-command.", "options": [ { @@ -2278,6 +2299,7 @@ }, { "name": "pandoc", + "hidden": false, "description": "Run the version of Pandoc embedded within Quarto.\n\nYou can pass arbitrary command line arguments to quarto pandoc (they will\nbe passed through unmodified to Pandoc)", "options": [ { @@ -2394,6 +2416,7 @@ "commands": [ { "name": "help", + "hidden": false, "description": "Show this help or the help of a sub-command.", "options": [ { @@ -2422,6 +2445,7 @@ }, { "name": "typst", + "hidden": false, "description": "Run the version of Typst embedded within Quarto.\n\nYou can pass arbitrary command line arguments to quarto typst (they will\nbe passed through unmodified to Typst)", "options": [ { @@ -2538,6 +2562,7 @@ "commands": [ { "name": "help", + "hidden": false, "description": "Show this help or the help of a sub-command.", "options": [ { @@ -2566,6 +2591,7 @@ }, { "name": "run", + "hidden": false, "description": "Run a TypeScript, R, Python, or Lua script.\n\nRun a utility script written in a variety of languages. For details, see:\nhttps://quarto.org/docs/projects/scripts.html#periodic-scripts", "options": [ { @@ -2673,6 +2699,7 @@ "commands": [ { "name": "help", + "hidden": false, "description": "Show this help or the help of a sub-command.", "options": [ { @@ -2701,6 +2728,7 @@ }, { "name": "list", + "hidden": false, "description": "Lists an extension or global dependency.", "options": [ { @@ -2817,6 +2845,7 @@ "commands": [ { "name": "help", + "hidden": false, "description": "Show this help or the help of a sub-command.", "options": [ { @@ -2845,6 +2874,7 @@ }, { "name": "install", + "hidden": false, "description": "Installs a global dependency (TinyTex or Chromium).", "options": [ { @@ -2985,6 +3015,7 @@ "commands": [ { "name": "help", + "hidden": false, "description": "Show this help or the help of a sub-command.", "options": [ { @@ -3013,6 +3044,7 @@ }, { "name": "uninstall", + "hidden": false, "description": "Removes an extension.", "options": [ { @@ -3145,6 +3177,7 @@ "commands": [ { "name": "help", + "hidden": false, "description": "Show this help or the help of a sub-command.", "options": [ { @@ -3173,6 +3206,7 @@ }, { "name": "tools", + "hidden": false, "description": "Display the status of Quarto installed dependencies", "options": [ { @@ -3203,6 +3237,7 @@ "commands": [ { "name": "help", + "hidden": false, "description": "Show this help or the help of a sub-command.", "options": [ { @@ -3231,6 +3266,7 @@ }, { "name": "publish", + "hidden": false, "description": "Publish a document or project to a provider.\n\nAvailable providers include:\n\n - Quarto Pub (quarto-pub)\n - GitHub Pages (gh-pages)\n - Posit Connect (connect)\n - Posit Cloud (posit-cloud)\n - Netlify (netlify)\n - Confluence (confluence)\n - Hugging Face Spaces (huggingface)\n\nAccounts are configured interactively during publishing.\nManage/remove accounts with: quarto publish accounts", "options": [ { @@ -3478,6 +3514,7 @@ "commands": [ { "name": "help", + "hidden": false, "description": "Show this help or the help of a sub-command.", "options": [ { @@ -3506,6 +3543,7 @@ }, { "name": "capabilities", + "hidden": false, "description": "Query for current capabilities (formats, engines, kernels etc.)", "options": [ { @@ -3613,6 +3651,7 @@ "commands": [ { "name": "help", + "hidden": false, "description": "Show this help or the help of a sub-command.", "options": [ { @@ -3641,6 +3680,7 @@ }, { "name": "inspect", + "hidden": false, "description": "Inspect a Quarto project or input path.\n\nInspecting a project returns its config and engines.\nInspecting an input path return its formats, engine, and dependent resources.\n\nEmits results of inspection as JSON to output (or stdout if not provided).", "options": [ { @@ -3765,6 +3805,7 @@ "commands": [ { "name": "help", + "hidden": false, "description": "Show this help or the help of a sub-command.", "options": [ { @@ -3793,6 +3834,7 @@ }, { "name": "check", + "hidden": false, "description": "Verify correct functioning of Quarto installation.\n\nCheck specific functionality with argument install, jupyter, knitr, or all.", "options": [ { @@ -3946,6 +3988,7 @@ "commands": [ { "name": "help", + "hidden": false, "description": "Show this help or the help of a sub-command.", "options": [ { @@ -3974,6 +4017,7 @@ }, { "name": "editor-support", + "hidden": true, "description": "Miscellaneous tools to support Quarto editor modes", "options": [ { @@ -3999,6 +4043,7 @@ "commands": [ { "name": "help", + "hidden": false, "description": "Show this help or the help of a sub-command.", "options": [ { @@ -4025,6 +4070,7 @@ }, { "name": "crossref", + "hidden": false, "description": "Index cross references for content", "options": [ { @@ -4160,6 +4206,7 @@ "commands": [ { "name": "help", + "hidden": false, "description": "Show this help or the help of a sub-command.", "options": [ { @@ -4190,6 +4237,7 @@ }, { "name": "call", + "hidden": false, "description": "Access functions of Quarto subsystems such as its rendering engines.", "options": [ { @@ -4215,6 +4263,7 @@ "commands": [ { "name": "help", + "hidden": false, "description": "Show this help or the help of a sub-command.", "options": [ { @@ -4241,6 +4290,7 @@ }, { "name": "engine", + "hidden": false, "description": "Access functionality specific to quarto's different rendering engines.", "options": [ { @@ -4348,6 +4398,7 @@ "commands": [ { "name": "help", + "hidden": false, "description": "Show this help or the help of a sub-command.", "options": [ { @@ -4374,6 +4425,7 @@ }, { "name": "julia", + "hidden": false, "description": "Access functionality specific to the julia rendering engine.", "options": [ { @@ -4481,6 +4533,7 @@ "commands": [ { "name": "help", + "hidden": false, "description": "Show this help or the help of a sub-command.", "options": [ { @@ -4507,6 +4560,7 @@ }, { "name": "status", + "hidden": false, "description": "Get status information on the currently running Julia server process.", "options": [ { @@ -4614,6 +4668,7 @@ "commands": [ { "name": "help", + "hidden": false, "description": "Show this help or the help of a sub-command.", "options": [ { @@ -4642,6 +4697,7 @@ }, { "name": "kill", + "hidden": false, "description": "Kill the control server if it is currently running. This will also kill all notebook worker processes.", "options": [ { @@ -4749,6 +4805,7 @@ "commands": [ { "name": "help", + "hidden": false, "description": "Show this help or the help of a sub-command.", "options": [ { @@ -4777,6 +4834,7 @@ }, { "name": "log", + "hidden": false, "description": "Print the content of the julia server log file if it exists which can be used to diagnose problems.", "options": [ { @@ -4884,6 +4942,7 @@ "commands": [ { "name": "help", + "hidden": false, "description": "Show this help or the help of a sub-command.", "options": [ { @@ -4912,6 +4971,7 @@ }, { "name": "close", + "hidden": false, "description": "Close the worker for a given notebook. If it is currently running, it will not be interrupted.", "options": [ { @@ -5034,6 +5094,7 @@ "commands": [ { "name": "help", + "hidden": false, "description": "Show this help or the help of a sub-command.", "options": [ { @@ -5062,6 +5123,7 @@ }, { "name": "stop", + "hidden": false, "description": "Send a message to the server that it should close all notebooks and exit. This will fail if any notebooks are not idle.", "options": [ { @@ -5169,6 +5231,7 @@ "commands": [ { "name": "help", + "hidden": false, "description": "Show this help or the help of a sub-command.", "options": [ { @@ -5203,6 +5266,7 @@ }, { "name": "dev-call", + "hidden": true, "description": "Access internals of Quarto - this command is not intended for general use.", "options": [ { @@ -5228,6 +5292,7 @@ "commands": [ { "name": "help", + "hidden": false, "description": "Show this help or the help of a sub-command.", "options": [ { @@ -5254,6 +5319,7 @@ }, { "name": "cli-info", + "hidden": false, "description": "Generate JSON information about the Quarto CLI.", "options": [ { @@ -5350,6 +5416,7 @@ "commands": [ { "name": "help", + "hidden": false, "description": "Show this help or the help of a sub-command.", "options": [ { From 5cf50db58c1fe384c26a2b9275372f4d96eeb33b Mon Sep 17 00:00:00 2001 From: Charlotte Wickham Date: Mon, 12 May 2025 10:49:07 -0700 Subject: [PATCH 18/18] Use `hidden` attribute to exclude commands --- docs/cli/dev-call.qmd | 11 ---- docs/cli/includes/_cli-commands.md | 47 ++++++++-------- docs/cli/includes/_dev-call-cli-info.md | 74 ------------------------- docs/cli/includes/_dev-call.md | 58 ------------------- tools/reference-cli-generate-md.R | 10 ++-- 5 files changed, 29 insertions(+), 171 deletions(-) delete mode 100644 docs/cli/dev-call.qmd delete mode 100644 docs/cli/includes/_dev-call-cli-info.md delete mode 100644 docs/cli/includes/_dev-call.md diff --git a/docs/cli/dev-call.qmd b/docs/cli/dev-call.qmd deleted file mode 100644 index 84e13a0514..0000000000 --- a/docs/cli/dev-call.qmd +++ /dev/null @@ -1,11 +0,0 @@ ---- -shift-heading-level-by: 1 ---- - -# dev-call - -{{< include includes/_dev-call.md >}} - -# dev-call cli-info - -{{< include includes/_dev-call-cli-info.md >}} \ No newline at end of file diff --git a/docs/cli/includes/_cli-commands.md b/docs/cli/includes/_cli-commands.md index 941b06a881..8a65ddcd2b 100644 --- a/docs/cli/includes/_cli-commands.md +++ b/docs/cli/includes/_cli-commands.md @@ -1,24 +1,23 @@ -|Command |Description | -|:------------|:--------------------------------------------------------------------------| -|[render](render.qmd)|Render files or projects to various document types. | -|[preview](preview.qmd)|Render and preview a document or website project. | -|[serve](serve.qmd)|Serve a Shiny interactive document. | -|[create](create.qmd)|Create a Quarto project or extension | -|[use](use.qmd)|Automate document or project setup tasks. | -|[add](add.qmd)|Add an extension to this folder or project | -|[update](update.qmd)|Updates an extension or global dependency. | -|[remove](remove.qmd)|Removes an extension. | -|[convert](convert.qmd)|Convert documents to alternate representations. | -|[pandoc](pandoc.qmd)|Run the version of Pandoc embedded within Quarto. | -|[typst](typst.qmd)|Run the version of Typst embedded within Quarto. | -|[run](run.qmd)|Run a TypeScript, R, Python, or Lua script. | -|[list](list.qmd)|Lists an extension or global dependency. | -|[install](install.qmd)|Installs a global dependency (TinyTex or Chromium). | -|[uninstall](uninstall.qmd)|Removes an extension. | -|[tools](tools.qmd)|Display the status of Quarto installed dependencies | -|[publish](publish.qmd)|Publish a document or project to a provider. | -|[capabilities](capabilities.qmd)|Query for current capabilities (formats, engines, kernels etc.) | -|[inspect](inspect.qmd)|Inspect a Quarto project or input path. | -|[check](check.qmd)|Verify correct functioning of Quarto installation. | -|[call](call.qmd)|Access functions of Quarto subsystems such as its rendering engines. | -|[dev-call](dev-call.qmd)|Access internals of Quarto - this command is not intended for general use. | +|Command |Description | +|:------------|:--------------------------------------------------------------------| +|[render](render.qmd)|Render files or projects to various document types. | +|[preview](preview.qmd)|Render and preview a document or website project. | +|[serve](serve.qmd)|Serve a Shiny interactive document. | +|[create](create.qmd)|Create a Quarto project or extension | +|[use](use.qmd)|Automate document or project setup tasks. | +|[add](add.qmd)|Add an extension to this folder or project | +|[update](update.qmd)|Updates an extension or global dependency. | +|[remove](remove.qmd)|Removes an extension. | +|[convert](convert.qmd)|Convert documents to alternate representations. | +|[pandoc](pandoc.qmd)|Run the version of Pandoc embedded within Quarto. | +|[typst](typst.qmd)|Run the version of Typst embedded within Quarto. | +|[run](run.qmd)|Run a TypeScript, R, Python, or Lua script. | +|[list](list.qmd)|Lists an extension or global dependency. | +|[install](install.qmd)|Installs a global dependency (TinyTex or Chromium). | +|[uninstall](uninstall.qmd)|Removes an extension. | +|[tools](tools.qmd)|Display the status of Quarto installed dependencies | +|[publish](publish.qmd)|Publish a document or project to a provider. | +|[capabilities](capabilities.qmd)|Query for current capabilities (formats, engines, kernels etc.) | +|[inspect](inspect.qmd)|Inspect a Quarto project or input path. | +|[check](check.qmd)|Verify correct functioning of Quarto installation. | +|[call](call.qmd)|Access functions of Quarto subsystems such as its rendering engines. | diff --git a/docs/cli/includes/_dev-call-cli-info.md b/docs/cli/includes/_dev-call-cli-info.md deleted file mode 100644 index 06fa2f13da..0000000000 --- a/docs/cli/includes/_dev-call-cli-info.md +++ /dev/null @@ -1,74 +0,0 @@ -Generate JSON information about the Quarto CLI. - -``` {.bash} -quarto dev-call cli-info -``` - - -## Options - - -```{=html} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Flags Arguments Description
-h, --help Show this help.
--log Path to log file
--log-level Log level (info, warning, error, critical)
--log-format Log format (plain, json-stream)
--quiet Suppress console output.
-``` - - - -## Commands - - -```{=html} - - - - - - - - - - - - - -
Command Description
help Show this help or the help of a sub-command.
-``` - - - - diff --git a/docs/cli/includes/_dev-call.md b/docs/cli/includes/_dev-call.md deleted file mode 100644 index c6be51d0d1..0000000000 --- a/docs/cli/includes/_dev-call.md +++ /dev/null @@ -1,58 +0,0 @@ -Access internals of Quarto - this command is not intended for general use. - -``` {.bash} -quarto dev-call -``` - - -## Options - - -```{=html} - - - - - - - - - - - - - - - -
Flags Arguments Description
-h, --help Show this help.
-``` - - - -## Commands - - -```{=html} - - - - - - - - - - - - - - - - - -
Command Description
help Show this help or the help of a sub-command.
cli-info Generate JSON information about the Quarto CLI.
-``` - - - - diff --git a/tools/reference-cli-generate-md.R b/tools/reference-cli-generate-md.R index bb3778ac15..c9606ff12e 100644 --- a/tools/reference-cli-generate-md.R +++ b/tools/reference-cli-generate-md.R @@ -119,9 +119,6 @@ cli_json <- read_json(here("docs", "cli", "cli-info.json")) cat("cli-info.json version: ", cli_json$version, "\n") commands <- cli_json$commands -exclude <- c("create-project", "editor-support") -commands <- commands[!map_chr(commands, "name") %in% exclude] - # Recursively extract commands and subcommands extract_commands <- function(commands, prefix = NULL) { result <- list() @@ -148,6 +145,7 @@ extract_commands <- function(commands, prefix = NULL) { tibble(commands = commands) |> unnest_wider(commands) |> + filter(!hidden) |> select(name, description) |> mutate( name = paste("[", name, "](", name, ".qmd)", sep = ""), @@ -159,11 +157,15 @@ tibble(commands = commands) |> # Individual commands ---------------------------------------------------- -all_commands <- extract_commands(commands) +hidden <- commands |> + map_lgl("hidden") + +all_commands <- extract_commands(commands[!hidden]) commands_tbl <- tibble(commands = all_commands) |> unnest_wider(commands) |> + filter(!hidden) |> filter(str_detect(name, "help", negate = TRUE)) |> rowwise()