diff --git a/_quarto.yml b/_quarto.yml index 5fcba34acf..9e19f5ef78 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: "quarto" + contents: docs/cli/*.qmd - id: prerelease title: "Quarto 1.3" contents: 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/add.qmd b/docs/cli/add.qmd new file mode 100644 index 0000000000..eb2a629dc3 --- /dev/null +++ b/docs/cli/add.qmd @@ -0,0 +1,6 @@ +--- +title: 'add' +--- + +{{< include includes/_add.md >}} + diff --git a/docs/cli/call.qmd b/docs/cli/call.qmd new file mode 100644 index 0000000000..41fe4e9f8e --- /dev/null +++ b/docs/cli/call.qmd @@ -0,0 +1,35 @@ +--- +title: 'call' +shift-heading-level-by: 1 +--- + +{{< include includes/_call.md >}} + +# call engine + +{{< 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 diff --git a/docs/cli/capabilities.qmd b/docs/cli/capabilities.qmd new file mode 100644 index 0000000000..16d18d8c2a --- /dev/null +++ b/docs/cli/capabilities.qmd @@ -0,0 +1,6 @@ +--- +title: 'capabilities' +--- + +{{< include includes/_capabilities.md >}} + diff --git a/docs/cli/check.qmd b/docs/cli/check.qmd new file mode 100644 index 0000000000..5c5869fd89 --- /dev/null +++ b/docs/cli/check.qmd @@ -0,0 +1,6 @@ +--- +title: 'check' +--- + +{{< include includes/_check.md >}} + diff --git a/docs/cli/cli-info.json b/docs/cli/cli-info.json new file mode 100644 index 0000000000..47fc29483a --- /dev/null +++ b/docs/cli/cli-info.json @@ -0,0 +1,5449 @@ +{ + "version": "99.9.9", + "commands": [ + { + "name": "render", + "hidden": false, + "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", + "hidden": false, + "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", + "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": [ + { + "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", + "hidden": false, + "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", + "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": [ + { + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "hidden": true, + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "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": [ + { + "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", + "hidden": false, + "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", + "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": [ + { + "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", + "hidden": false, + "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", + "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": [ + { + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "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": [ + { + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "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": [ + { + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "hidden": true, + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "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": [ + { + "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", + "hidden": false, + "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", + "hidden": true, + "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", + "hidden": false, + "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", + "hidden": false, + "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", + "hidden": false, + "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": [] + } + ] + } + ] + } + ] +} diff --git a/docs/cli/convert.qmd b/docs/cli/convert.qmd new file mode 100644 index 0000000000..3473db59e4 --- /dev/null +++ b/docs/cli/convert.qmd @@ -0,0 +1,6 @@ +--- +title: 'convert' +--- + +{{< include includes/_convert.md >}} + diff --git a/docs/cli/create.qmd b/docs/cli/create.qmd new file mode 100644 index 0000000000..2442da3cca --- /dev/null +++ b/docs/cli/create.qmd @@ -0,0 +1,6 @@ +--- +title: 'create' +--- + +{{< include includes/_create.md >}} + diff --git a/docs/cli/includes/_add.md b/docs/cli/includes/_add.md new file mode 100644 index 0000000000..20e307a82c --- /dev/null +++ b/docs/cli/includes/_add.md @@ -0,0 +1,107 @@ +Add an extension to this folder or project + +``` {.bash} +quarto add +``` + + +## Options + + +```{=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 + + +```{=html} + + + + + + + + + + + + + +
Command Description
help Show this help or the help of a sub-command.
+``` + + + +## Examples +### Install extension (Github) + +``` {.bash filename='Terminal'} +quarto add / +``` + +### Install extension (file) + +``` {.bash filename='Terminal'} +quarto add +``` + +### Install extension (url) + +``` {.bash filename='Terminal'} +quarto add +``` + 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..9fa94a13d7 --- /dev/null +++ b/docs/cli/includes/_call-engine-julia-close.md @@ -0,0 +1,84 @@ +Close the worker for a given notebook. If it is currently running, it will not be interrupted. + +``` {.bash} +quarto call engine julia close +``` + + +## Options + + +```{=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 + + +```{=html} + + + + + + + + + + + + + +
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..eece62d552 --- /dev/null +++ b/docs/cli/includes/_call-engine-julia-kill.md @@ -0,0 +1,79 @@ +Kill the control server if it is currently running. This will also kill all notebook worker processes. + +``` {.bash} +quarto call engine julia kill +``` + + +## Options + + +```{=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 + + +```{=html} + + + + + + + + + + + + + +
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..bfa2ce8090 --- /dev/null +++ b/docs/cli/includes/_call-engine-julia-log.md @@ -0,0 +1,79 @@ +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 + + +```{=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 + + +```{=html} + + + + + + + + + + + + + +
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..8106158461 --- /dev/null +++ b/docs/cli/includes/_call-engine-julia-status.md @@ -0,0 +1,79 @@ +Get status information on the currently running Julia server process. + +``` {.bash} +quarto call engine julia status +``` + + +## Options + + +```{=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 + + +```{=html} + + + + + + + + + + + + + +
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..7414a7d72b --- /dev/null +++ b/docs/cli/includes/_call-engine-julia-stop.md @@ -0,0 +1,79 @@ +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 + + +```{=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 + + +```{=html} + + + + + + + + + + + + + +
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..d08c000fb8 --- /dev/null +++ b/docs/cli/includes/_call-engine-julia.md @@ -0,0 +1,99 @@ +Access functionality specific to the julia rendering engine. + +``` {.bash} +quarto call engine julia +``` + + +## Options + + +```{=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 + + +```{=html} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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/docs/cli/includes/_call-engine.md b/docs/cli/includes/_call-engine.md new file mode 100644 index 0000000000..253d281c64 --- /dev/null +++ b/docs/cli/includes/_call-engine.md @@ -0,0 +1,83 @@ +Access functionality specific to quarto's different rendering engines. + +``` {.bash} +quarto call engine +``` + + +## 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.
--profile Active project profile(s)
+``` + + + +## Commands + + +```{=html} + + + + + + + + + + + + + + + + + +
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/includes/_call.md b/docs/cli/includes/_call.md new file mode 100644 index 0000000000..47865ac6e4 --- /dev/null +++ b/docs/cli/includes/_call.md @@ -0,0 +1,58 @@ +Access functions of Quarto subsystems such as its rendering engines. + +``` {.bash} +quarto 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.
engine Access functionality specific to quarto's different rendering engines.
+``` + + + + diff --git a/docs/cli/includes/_capabilities.md b/docs/cli/includes/_capabilities.md new file mode 100644 index 0000000000..df5d8fcf66 --- /dev/null +++ b/docs/cli/includes/_capabilities.md @@ -0,0 +1,79 @@ +Query for current capabilities (formats, engines, kernels etc.) + +``` {.bash} +quarto capabilities +``` + + +## 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.
--profile Active project profile(s)
+``` + + + +## Commands + + +```{=html} + + + + + + + + + + + + + +
Command Description
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 new file mode 100644 index 0000000000..3be6c65f07 --- /dev/null +++ b/docs/cli/includes/_check.md @@ -0,0 +1,115 @@ +Verify correct functioning of Quarto installation. + +Check specific functionality with argument install, jupyter, knitr, or all. + +``` {.bash} +quarto check [target:string] +``` + + +## Options + + +```{=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 + + +```{=html} + + + + + + + + + + + + + +
Command Description
help Show this help or the help of a sub-command.
+``` + + + +## Examples +### Check Quarto installation + +``` {.bash filename='Terminal'} +quarto check install +``` + +### Check Jupyter engine + +``` {.bash filename='Terminal'} +quarto check jupyter +``` + +### Check Knitr engine + +``` {.bash filename='Terminal'} +quarto check knitr +``` + +### Check installation and all engines + +``` {.bash filename='Terminal'} +quarto check all +``` + diff --git a/docs/cli/includes/_cli-commands.md b/docs/cli/includes/_cli-commands.md new file mode 100644 index 0000000000..8a65ddcd2b --- /dev/null +++ b/docs/cli/includes/_cli-commands.md @@ -0,0 +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. | diff --git a/docs/cli/includes/_convert.md b/docs/cli/includes/_convert.md new file mode 100644 index 0000000000..cb64259c3b --- /dev/null +++ b/docs/cli/includes/_convert.md @@ -0,0 +1,107 @@ +Convert documents to alternate representations. + +``` {.bash} +quarto convert +``` + + +## Options + + +```{=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 + + +```{=html} + + + + + + + + + + + + + +
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 +``` + +### Convert markdown to notebook + +``` {.bash filename='Terminal'} +quarto convert mydocument.qmd +``` + +### Convert notebook to markdown, writing to file + +``` {.bash filename='Terminal'} +quarto convert mydocument.ipynb --output mydoc.qmd +``` + diff --git a/docs/cli/includes/_create.md b/docs/cli/includes/_create.md new file mode 100644 index 0000000000..3c45823768 --- /dev/null +++ b/docs/cli/includes/_create.md @@ -0,0 +1,94 @@ +Create a Quarto project or extension + +``` {.bash} +quarto create [type] [commands...] +``` + + +## Options + + +```{=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 + + +```{=html} + + + + + + + + + + + + + +
Command Description
help Show this help or the help of a sub-command.
+``` + + + + diff --git a/docs/cli/includes/_inspect.md b/docs/cli/includes/_inspect.md new file mode 100644 index 0000000000..e28a5129da --- /dev/null +++ b/docs/cli/includes/_inspect.md @@ -0,0 +1,108 @@ +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 + + +```{=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 + + +```{=html} + + + + + + + + + + + + + +
Command Description
help Show this help or the help of a sub-command.
+``` + + + +## Examples +### Inspect project in current directory + +``` {.bash filename='Terminal'} +quarto inspect +``` + +### Inspect project in directory + +``` {.bash filename='Terminal'} +quarto inspect myproject +``` + +### Inspect input path + +``` {.bash filename='Terminal'} +quarto inspect document.md +``` + +### Inspect input path and write to file + +``` {.bash filename='Terminal'} +quarto inspect document.md output.json +``` + diff --git a/docs/cli/includes/_install.md b/docs/cli/includes/_install.md new file mode 100644 index 0000000000..66ccca495b --- /dev/null +++ b/docs/cli/includes/_install.md @@ -0,0 +1,107 @@ +Installs a global dependency (TinyTex or Chromium). + +``` {.bash} +quarto install [target...] +``` + + +## Options + + +```{=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 + + +```{=html} + + + + + + + + + + + + + +
Command Description
help Show this help or the help of a sub-command.
+``` + + + +## Examples +### Install TinyTeX + +``` {.bash filename='Terminal'} +quarto install tinytex +``` + +### Install Chromium + +``` {.bash filename='Terminal'} +quarto install chromium +``` + +### Choose tool to install + +``` {.bash filename='Terminal'} +quarto install +``` + diff --git a/docs/cli/includes/_list.md b/docs/cli/includes/_list.md new file mode 100644 index 0000000000..3592931437 --- /dev/null +++ b/docs/cli/includes/_list.md @@ -0,0 +1,91 @@ +Lists an extension or global dependency. + +``` {.bash} +quarto list +``` + + +## 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.
--profile Active project profile(s)
+``` + + + +## Commands + + +```{=html} + + + + + + + + + + + + + +
Command Description
help Show this help or the help of a sub-command.
+``` + + + +## Examples +### List installed extensions + +``` {.bash filename='Terminal'} +quarto list extensions +``` + +### List global tools + +``` {.bash filename='Terminal'} +quarto list tools +``` + diff --git a/docs/cli/includes/_pandoc.md b/docs/cli/includes/_pandoc.md new file mode 100644 index 0000000000..dd27e301d7 --- /dev/null +++ b/docs/cli/includes/_pandoc.md @@ -0,0 +1,94 @@ +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 + + +```{=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 + + +```{=html} + + + + + + + + + + + + + +
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 +``` + +### List Pandoc output formats + +``` {.bash filename='Terminal'} +quarto pandoc --list-output-formats +``` + diff --git a/docs/cli/includes/_preview.md b/docs/cli/includes/_preview.md new file mode 100644 index 0000000000..2f6fb025a2 --- /dev/null +++ b/docs/cli/includes/_preview.md @@ -0,0 +1,178 @@ +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 + + +```{=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 + + +```{=html} + + + + + + + + + + + + + +
Command Description
help Show this help or the help of a sub-command.
+``` + + + +## Examples +### Preview document + +``` {.bash filename='Terminal'} +quarto preview doc.qmd +``` + +### Preview document with render command line args + +``` {.bash filename='Terminal'} +quarto preview doc.qmd --toc +``` + +### Preview document (don't watch for input changes) + +``` {.bash filename='Terminal'} +quarto preview doc.qmd --no-watch-inputs +``` + +### Preview website with most recent execution results + +``` {.bash filename='Terminal'} +quarto preview +``` + +### Previewing website using a specific port + +``` {.bash filename='Terminal'} +quarto preview --port 4444 +``` + +### Preview website (don't open a browser) + +``` {.bash filename='Terminal'} +quarto preview --no-browser +``` + +### Fully render all website/book formats then preview + +``` {.bash filename='Terminal'} +quarto preview --render all +``` + +### Fully render the html format then preview + +``` {.bash filename='Terminal'} +quarto preview --render html +``` + diff --git a/docs/cli/includes/_publish.md b/docs/cli/includes/_publish.md new file mode 100644 index 0000000000..58be092f48 --- /dev/null +++ b/docs/cli/includes/_publish.md @@ -0,0 +1,200 @@ +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 + + +```{=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 + + +```{=html} + + + + + + + + + + + + + +
Command Description
help Show this help or the help of a sub-command.
+``` + + + +## Examples +### Publish project (prompt for provider) + +``` {.bash filename='Terminal'} +quarto publish +``` + +### Publish document (prompt for provider) + +``` {.bash filename='Terminal'} +quarto publish document.qmd +``` + +### Publish project to Hugging Face Spaces + +``` {.bash filename='Terminal'} +quarto publish huggingface +``` + +### Publish project to Netlify + +``` {.bash filename='Terminal'} +quarto publish netlify +``` + +### Publish with explicit target + +``` {.bash filename='Terminal'} +quarto publish netlify --id DA36416-F950-4647-815C-01A24233E294 +``` + +### Publish project to GitHub Pages + +``` {.bash filename='Terminal'} +quarto publish gh-pages +``` + +### Publish project to Posit Connect + +``` {.bash filename='Terminal'} +quarto publish connect +``` + +### Publish with explicit credentials + +``` {.bash filename='Terminal'} +quarto publish connect --server example.com --token 01A24233E294 +``` + +### Publish project to Posit Cloud + +``` {.bash filename='Terminal'} +quarto publish posit-cloud +``` + +### Publish without confirmation prompt + +``` {.bash filename='Terminal'} +quarto publish --no-prompt +``` + +### Publish without rendering + +``` {.bash filename='Terminal'} +quarto publish --no-render +``` + +### Publish without opening browser + +``` {.bash filename='Terminal'} +quarto publish --no-browser +``` + +### Manage/remove publishing accounts + +``` {.bash filename='Terminal'} +quarto publish accounts +``` + diff --git a/docs/cli/includes/_remove.md b/docs/cli/includes/_remove.md new file mode 100644 index 0000000000..6516c38ced --- /dev/null +++ b/docs/cli/includes/_remove.md @@ -0,0 +1,95 @@ +Removes an extension. + +``` {.bash} +quarto remove [target...] +``` + + +## Options + + +```{=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 + + +```{=html} + + + + + + + + + + + + + +
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/includes/_render.md b/docs/cli/includes/_render.md new file mode 100644 index 0000000000..272bfbc36c --- /dev/null +++ b/docs/cli/includes/_render.md @@ -0,0 +1,205 @@ +Render files or projects to various document types. + +``` {.bash} +quarto render [input:string] [...args] +``` + + +## Options + + +```{=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 + + +```{=html} + + + + + + + + + + + + + +
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 +``` + +### Render Notebook + +``` {.bash filename='Terminal'} +quarto render notebook.ipynb +quarto render notebook.ipynb --to docx +quarto render notebook.ipynb --to pdf --toc +``` + +### Render Project + +``` {.bash filename='Terminal'} +quarto render +quarto render projdir +``` + +### Render w/ Metadata + +``` {.bash filename='Terminal'} +quarto render document.qmd -M echo:false +quarto render document.qmd -M code-fold:true +``` + +### Render to Stdout + +``` {.bash filename='Terminal'} +quarto render document.qmd --output - +``` + diff --git a/docs/cli/includes/_run.md b/docs/cli/includes/_run.md new file mode 100644 index 0000000000..9f5e938ab3 --- /dev/null +++ b/docs/cli/includes/_run.md @@ -0,0 +1,82 @@ +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 + + +```{=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 + + +```{=html} + + + + + + + + + + + + + +
Command Description
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 new file mode 100644 index 0000000000..f0b626c3f0 --- /dev/null +++ b/docs/cli/includes/_serve.md @@ -0,0 +1,113 @@ +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 + + +```{=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 + + +```{=html} + + + + + + + + + + + + + +
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 +``` + +### Serve a document without rendering + +``` {.bash filename='Terminal'} +quarto serve dashboard.qmd --no-render +``` + diff --git a/docs/cli/includes/_tools.md b/docs/cli/includes/_tools.md new file mode 100644 index 0000000000..3a2fc2f915 --- /dev/null +++ b/docs/cli/includes/_tools.md @@ -0,0 +1,60 @@ +Display the status of Quarto installed dependencies + +``` {.bash} +quarto tools +``` + + +## 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.
+``` + + + +## Examples +### Show tool status + +``` {.bash filename='Terminal'} +quarto tools +``` + diff --git a/docs/cli/includes/_typst.md b/docs/cli/includes/_typst.md new file mode 100644 index 0000000000..59fa383699 --- /dev/null +++ b/docs/cli/includes/_typst.md @@ -0,0 +1,94 @@ +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 + + +```{=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 + + +```{=html} + + + + + + + + + + + + + +
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 +``` + +### List all discovered fonts in system and custom font paths + +``` {.bash filename='Terminal'} +quarto typst fonts +``` + diff --git a/docs/cli/includes/_uninstall.md b/docs/cli/includes/_uninstall.md new file mode 100644 index 0000000000..97bc645160 --- /dev/null +++ b/docs/cli/includes/_uninstall.md @@ -0,0 +1,95 @@ +Removes an extension. + +``` {.bash} +quarto uninstall [tool] +``` + + +## Options + + +```{=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 + + +```{=html} + + + + + + + + + + + + + +
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/includes/_update.md b/docs/cli/includes/_update.md new file mode 100644 index 0000000000..cb78f32f23 --- /dev/null +++ b/docs/cli/includes/_update.md @@ -0,0 +1,125 @@ +Updates an extension or global dependency. + +``` {.bash} +quarto update [target...] +``` + + +## Options + + +```{=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 + + +```{=html} + + + + + + + + + + + + + +
Command Description
help Show this help or the help of a sub-command.
+``` + + + +## Examples +### Update extension (Github) + +``` {.bash filename='Terminal'} +quarto update extension / +``` + +### Update extension (file) + +``` {.bash filename='Terminal'} +quarto update extension +``` + +### Update extension (url) + +``` {.bash filename='Terminal'} +quarto update extension +``` + +### Update TinyTeX + +``` {.bash filename='Terminal'} +quarto update tool tinytex +``` + +### Update Chromium + +``` {.bash filename='Terminal'} +quarto update tool chromium +``` + +### Choose tool to update + +``` {.bash filename='Terminal'} +quarto update tool +``` + diff --git a/docs/cli/includes/_use-binder.md b/docs/cli/includes/_use-binder.md new file mode 100644 index 0000000000..a30f631a3a --- /dev/null +++ b/docs/cli/includes/_use-binder.md @@ -0,0 +1,66 @@ +Configure the current project with Binder support. + +``` {.bash} +quarto use binder +``` + + +## Options + + +```{=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)
+``` + + + + + + +## 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..2b188e6aa8 --- /dev/null +++ b/docs/cli/includes/_use-template.md @@ -0,0 +1,61 @@ +Use a Quarto template for this directory or project. + +``` {.bash} +quarto use template +``` + + +## Options + + +```{=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.
+``` + + + + + + +## Examples +### Use a template from Github + +``` {.bash filename='Terminal'} +quarto use template / +``` + diff --git a/docs/cli/includes/_use.md b/docs/cli/includes/_use.md new file mode 100644 index 0000000000..e61061e25a --- /dev/null +++ b/docs/cli/includes/_use.md @@ -0,0 +1,58 @@ +Automate document or project setup tasks. + +``` {.bash} +quarto use [target:string] +``` + + +## Options + + +```{=html} + + + + + + + + + + + + + + + +
Flags Arguments Description
--no-prompt Do not prompt to confirm actions
+``` + + + +## Commands + + +```{=html} + + + + + + + + + + + + + + + + + +
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/index.qmd b/docs/cli/index.qmd new file mode 100644 index 0000000000..df3d9be0ea --- /dev/null +++ b/docs/cli/index.qmd @@ -0,0 +1,6 @@ +--- +title: Command Line Reference +tbl-colwidths: [20, 80] +--- + +{{< include includes/_cli-commands.md >}} \ No newline at end of file diff --git a/docs/cli/inspect.qmd b/docs/cli/inspect.qmd new file mode 100644 index 0000000000..300e54be58 --- /dev/null +++ b/docs/cli/inspect.qmd @@ -0,0 +1,6 @@ +--- +title: 'inspect' +--- + +{{< include includes/_inspect.md >}} + diff --git a/docs/cli/install.qmd b/docs/cli/install.qmd new file mode 100644 index 0000000000..19a8de7c03 --- /dev/null +++ b/docs/cli/install.qmd @@ -0,0 +1,6 @@ +--- +title: 'install' +--- + +{{< include includes/_install.md >}} + diff --git a/docs/cli/list.qmd b/docs/cli/list.qmd new file mode 100644 index 0000000000..639d7df920 --- /dev/null +++ b/docs/cli/list.qmd @@ -0,0 +1,6 @@ +--- +title: 'list' +--- + +{{< include includes/_list.md >}} + diff --git a/docs/cli/pandoc.qmd b/docs/cli/pandoc.qmd new file mode 100644 index 0000000000..9df3ee4c17 --- /dev/null +++ b/docs/cli/pandoc.qmd @@ -0,0 +1,6 @@ +--- +title: 'pandoc' +--- + +{{< include includes/_pandoc.md >}} + diff --git a/docs/cli/preview.qmd b/docs/cli/preview.qmd new file mode 100644 index 0000000000..40b9d181e6 --- /dev/null +++ b/docs/cli/preview.qmd @@ -0,0 +1,6 @@ +--- +title: 'preview' +--- + +{{< include includes/_preview.md >}} + diff --git a/docs/cli/publish.qmd b/docs/cli/publish.qmd new file mode 100644 index 0000000000..1c9e1490c2 --- /dev/null +++ b/docs/cli/publish.qmd @@ -0,0 +1,6 @@ +--- +title: 'publish' +--- + +{{< include includes/_publish.md >}} + diff --git a/docs/cli/remove.qmd b/docs/cli/remove.qmd new file mode 100644 index 0000000000..94298946b2 --- /dev/null +++ b/docs/cli/remove.qmd @@ -0,0 +1,6 @@ +--- +title: 'remove' +--- + +{{< include includes/_remove.md >}} + diff --git a/docs/cli/render.qmd b/docs/cli/render.qmd new file mode 100644 index 0000000000..23ac81b429 --- /dev/null +++ b/docs/cli/render.qmd @@ -0,0 +1,6 @@ +--- +title: 'render' +--- + +{{< include includes/_render.md >}} + diff --git a/docs/cli/run.qmd b/docs/cli/run.qmd new file mode 100644 index 0000000000..46883f3f9b --- /dev/null +++ b/docs/cli/run.qmd @@ -0,0 +1,6 @@ +--- +title: 'run' +--- + +{{< include includes/_run.md >}} + diff --git a/docs/cli/serve.qmd b/docs/cli/serve.qmd new file mode 100644 index 0000000000..846a238f76 --- /dev/null +++ b/docs/cli/serve.qmd @@ -0,0 +1,6 @@ +--- +title: 'serve' +--- + +{{< include includes/_serve.md >}} + diff --git a/docs/cli/tools.qmd b/docs/cli/tools.qmd new file mode 100644 index 0000000000..dd33f25559 --- /dev/null +++ b/docs/cli/tools.qmd @@ -0,0 +1,6 @@ +--- +title: 'tools' +--- + +{{< include includes/_tools.md >}} + diff --git a/docs/cli/typst.qmd b/docs/cli/typst.qmd new file mode 100644 index 0000000000..783815d0f1 --- /dev/null +++ b/docs/cli/typst.qmd @@ -0,0 +1,6 @@ +--- +title: 'typst' +--- + +{{< include includes/_typst.md >}} + diff --git a/docs/cli/uninstall.qmd b/docs/cli/uninstall.qmd new file mode 100644 index 0000000000..8a7adb6f58 --- /dev/null +++ b/docs/cli/uninstall.qmd @@ -0,0 +1,6 @@ +--- +title: 'uninstall' +--- + +{{< include includes/_uninstall.md >}} + diff --git a/docs/cli/update.qmd b/docs/cli/update.qmd new file mode 100644 index 0000000000..614613fe1b --- /dev/null +++ b/docs/cli/update.qmd @@ -0,0 +1,6 @@ +--- +title: 'update' +--- + +{{< include includes/_update.md >}} + diff --git a/docs/cli/use.qmd b/docs/cli/use.qmd new file mode 100644 index 0000000000..c1c81e4cce --- /dev/null +++ b/docs/cli/use.qmd @@ -0,0 +1,15 @@ +--- +shift-heading-level-by: 1 +--- + +# use + +{{< include includes/_use.md >}} + +# use template + +{{< include includes/_use-template.md >}} + +# use binder + +{{< include includes/_use-binder.md >}} 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 diff --git a/tools/reference-cli-generate-md.R b/tools/reference-cli-generate-md.R new file mode 100644 index 0000000000..c9606ff12e --- /dev/null +++ b/tools/reference-cli-generate-md.R @@ -0,0 +1,191 @@ +# Generates .md files in docs/cli/includes/ from `cli-info.json` in docs/cli/ +# 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) +library(here) +library(tidyverse) +library(fansi) + +options(knitr.table.format = "html") + +# Helper Functions ------------------------------------------------------- + +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") +} + +make_code <- function(x) { + paste0("", x, "") +} + +process_options <- function(options) { + options_table <- tibble(options = options) |> + unnest_wider(options) |> + select(flags, typeDefinition, description) |> + rowwise() |> + mutate( + flags = paste0(make_code(flags), collapse = ", "), + typeDefinition = ifelse( + 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) { + if (length(commands) == 0) { + return("") + } + commands_table <- tibble(commands = commands) |> + unnest_wider(commands) |> + mutate(name = make_code(name)) |> + 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") +} + +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) |> + paste(collapse = "\n") + 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( + strip_ctl(description, ctl = "sgr"), + usage_text, + "\n", + heading("Options"), + options_table, + "\n", + commands_table, + "\n", + examples_text, + sep = "\n", + collapse = "\n" + ) +} + + +# 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 + +# 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(!hidden) |> + select(name, description) |> + mutate( + name = paste("[", name, "](", name, ".qmd)", sep = ""), + description = stringr::str_extract(description, "^[^\\n]+") + ) |> + knitr::kable(col.names = c("Command", "Description"), format = "pipe") |> + writeLines(here("docs", "cli", "includes", "_cli-commands.md")) + + +# Individual 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() + +commands_content <- commands_tbl |> + mutate( + filename = here( + "docs", + "cli", + "includes", + paste0("_", gsub(" ", "-", name), ".md") + ), + content = md_content( + name, + description, + usage, + options, + commands, + examples + ) + ) + +commands_content |> + group_walk(~ with(.x, writeLines(content, filename)))