---
title: "use_qrtdown_cli"
---

[< Back to Reference](../reference.qmd) | [View source](https://usrbinr.codeberg.page/qrtdown//src/branch/main/R/usethis.R#L785)

# `use_qrtdown_cli()`

Install qrtdown CLI

## Usage

```r
use_qrtdown_cli(path = NULL)
```

## Arguments

| Argument | Description |
|----------|-------------|
| `path` | Directory to install the CLI script. Defaults to ~/.local/bin on Linux/macOS. This directory should be in your PATH. |

## Value

Invisibly returns the path to the installed CLI script.

## Description

Installs the `qrtdown` command-line interface, allowing you to run
qrtdown commands directly from the terminal instead of from R.

## Details

After installation, you can use commands like:

qrtdown init
qrtdown build
qrtdown build --clean
quarto preview
qrtdown new article my-guide
qrtdown deploy

Run `qrtdown --help` for full usage information.

The CLI requires the `docopt` package. Install it with
`install.packages("docopt")` if not already installed.

## Examples

```r
## Not run: 
use_qrtdown_cli()

# Then from terminal:
# qrtdown build
# quarto preview

## End(Not run)
```

