Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reference for CLI subcommands? #598

Open
Tracked by #9093
eitsupi opened this issue Apr 9, 2022 · 7 comments
Open
Tracked by #9093

Reference for CLI subcommands? #598

eitsupi opened this issue Apr 9, 2022 · 7 comments
Assignees
Labels
documentation Doc improvements & quarto-web epic An issue that contains other issues
Milestone

Comments

@eitsupi
Copy link
Contributor

eitsupi commented Apr 9, 2022

Currently the Quarto CLI has many subcommands.
It would be nice to have a comprehensive reference page for subcommands.

$ quarto --help

  Usage:   quarto 
  Version: 0.9.215
                  

  Description:

    Quarto CLI

  Options:

    -h, --help     - Show this help.                            
    -V, --version  - Show the version number for this program.  

  Commands:

    render          [input] [args...]  - Render input file(s) to various document types.                                                
    serve           [input]            - Serve an interactive document.                                                                 
    create-project  [dir]              - Create a project for rendering multiple documents                                              
    preview         [file] [args...]   - Render and preview a Quarto document or website project. Automatically reloads the browser when
    convert         [input]            - Convert documents to alternate representations.                                                
    capabilities                       - Query for current capabilities (output formats, engines, kernels etc.)                         
    check           [target]           - Check and verify correct functioning of Quarto installation and computation engines.           
    inspect         [path]             - Inspect a Quarto project or input path. Inspecting a project returns its config and engines.   
    tools           [command] [tool]   - Manage the installation, update, and uninstallation of useful tools.                           
    help            [command]          - Show this help or the help of a sub-command.
@eitsupi eitsupi changed the title Reference for CLI sub commands? Reference for CLI subcommands? Apr 9, 2022
@jjallaire jjallaire transferred this issue from quarto-dev/quarto-web Apr 9, 2022
@jjallaire jjallaire added this to the Future milestone Jun 8, 2022
@allenmanning allenmanning added documentation Doc improvements & quarto-web epic An issue that contains other issues labels Mar 31, 2023
@cwickham
Copy link
Collaborator

Moving from related issue:

Also, I noticed the quarto use command is not at all documented, not even in Quarto CLI itself.

@mcanouil
Copy link
Collaborator

mcanouil commented May 4, 2023

FYI, related to #5421.

@cderv
Copy link
Collaborator

cderv commented Sep 4, 2023

@cderv cderv modified the milestones: Future, v1.5 Feb 1, 2024
@cwickham
Copy link
Collaborator

Related to #1531

@SichangHe
Copy link

Some shell configurations read the manpage and generate shell completions. Related: #3216.

@cscheid
Copy link
Collaborator

cscheid commented Oct 9, 2024

We should investigate if Cliffy's Command objects support extracting existing options and configuration, from which we can generate a command-reference.yml file to be used in quarto-web.

@winniehell
Copy link
Contributor

it sounds like #10878 wants to be resolved first

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Doc improvements & quarto-web epic An issue that contains other issues
Projects
None yet
Development

No branches or pull requests

9 participants