<!-- markdownlint-disable MD024 -->

# CLI

Ajour accepts arguments and can even run certain operations on the command line
without launching the GUI, such as updating all addons. This makes it possible to
manage your addon collection through scripts and scheduling.

You can pass `--help` to see a full list of supported flags, options and commands.

```text
USAGE:
    ajour [OPTIONS] [SUBCOMMAND]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
        --aa <antialiasing>        Enable / Disable Anti-aliasing (true / false)
        --data <data-directory>    Path to a custom data directory for the app

SUBCOMMANDS:
    backup     Backup your WTF and/or AddOns folders
    install    Install an addon from the command line
    update              Update all addons and WeakAuras
    update-addons       Update all addons from the command line then exit
    update-weakauras    Update all WeakAuras from the command line then exit`
```

## Options

You can attach different options together with a [subcommand](#subcommands).
Currently available options:

```sh
# Enable or disable anti-aliasing.
# [default: true]

--aa <true/false>

# Path to a custom data directory for the app.
# [default]:
# macOS/Linux: $HOME/.config/ajour
# Windows: %APPDATA%\ajour

--data <data-directory>
```

## Subcommands

### Backup

Backup your WTF and/or AddOns folders.

```sh
USAGE:
    ajour backup [OPTIONS] <destination>

OPTIONS:
    # Folder to backup
    # [default: both]
    # [possible values: both, wtf, addons]

    -b, --backup-folder <backup-folder>

    # Space separated list of flavors to include in backup.
    # If ommited, all flavors will be included
    # [possible values: retail, ptr, beta, classic, classic_ptr]

    -f, --flavors <flavors>

    # Compression format to use
    # [default: zip]
    # [possible values: zip, zstd]

    -c, --compression-format <compression-format>

ARGS:
    # folder to save backups to

    <destination>
```

#### Example

```sh
# Backup both WTF and AddOns folder for all flavors

ajour backup -b both

# Backup the WTF folder for Retail

ajour backup -b wtf -f retail /tmp
```

### Install

Install an addon from the command line.

```sh
USAGE:
    ajour install <flavor> <url>

ARGS:
    # Flavor to install addon under
    # [possible values: retail, ptr, beta, classic, classic_ptr]

    <flavor>

    # Source url
    # [Github & Gitlab currently supported]

    <url>
```

#### Example

```sh
# Install Hekili from Github

ajour install retail https://github.com/Hekili/hekili
```

### Update

Update all addons and/or WeakAuras from the command line then exit.

```sh
USAGE:
    ajour update
    ajour update-addons
    ajour update-weakauras
```

#### Example

```sh
# Update all addons and WeakAuras

ajour update

# Update all addons

ajour update-addons

# Update all WeakAuras

ajour update-weakauras
```