CLI Reference

This page provides documentation for the commandline.

at2

Usage:

at2 [OPTIONS] COMMAND [ARGS]...

Options:

  -c, --config FILE       Path to config file
  -v, --verbose           Verbose logging
  -u, --utf8-compat-mode  Try work around utf-8 errors, not recommended
  --version               Show the version and exit.
  --help                  Show this message and exit.

at2 add

Add new torrents to a client.

Usage:

at2 add [OPTIONS] CLIENT [TORRENT]...

Options:

  -e, --exact                     Exact matching mode. Can also be considered
                                  a "reseed" mode. Disables all other modes.
  -s, --hash-probe                Probe matched files for full pieces to
                                  ensure the data matches.
  -a, --hash-size                 Hash size matching mode, checks for files
                                  with same size but different filenames.
  --print-summary                 Print a summary of all actions when done.
  --chown TEXT                    Chown the data folder when creating links.
  --dry-run                       Do not actually create links and add the
                                  torrents, just check what would happen.
  --move-torrent-on-add PATH      Move the torrent to this path after it has
                                  been added successfully to the client.
  --stopped                       Add the torrent in stopped state.
  -t, --store-path-template TEXT  Pass a custom template instead of using the
                                  one defined in the config file.
  -v, --store-path-variable TEXT  Variable used for store path using a
                                  key=value syntax.
  --help                          Show this message and exit.

at2 check-config

Checks if the config file exists and is loadable.

Usage:

at2 check-config [OPTIONS]

Options:

  --help  Show this message and exit.

at2 cleanup-cache

Cleanup RW cache for expired items.

Usage:

at2 cleanup-cache [OPTIONS]

Options:

  --help  Show this message and exit.

at2 find-unseeded

Find unseeded paths.

Usage:

at2 find-unseeded [OPTIONS] [PATH]...

Options:

  -e, --escape-paths  Escape the output paths
  --help              Show this message and exit.

at2 ls

See what is seeded for a given path.

Usage:

at2 ls [OPTIONS] [PATH]...

Options:

  -s, --summary        End the listing with a summary
  -d, --depth INTEGER
  --help               Show this message and exit.

at2 rm

Remove all torrents seeding data from a path. Does not delete the actual data.

Usage:

at2 rm [OPTIONS] PATH...

Options:

  -l, --client TEXT  Remove from a specific client
  --help             Show this message and exit.

at2 scan

Scan your local paths files.

Usage:

at2 scan [OPTIONS]

Options:

  -p, --path PATH  Partial scan a given path, does not remove removed files
                   from the database.
  --help           Show this message and exit.

at2 scan-clients

Scan your clients for files.

Usage:

at2 scan-clients [OPTIONS]

Options:

  -l, --client TEXT  Scan a specific client
  -f, --full         Clear old data and do a full scan
  -a, --fast         Run a fast scan, does not detect moved torrents.
                     Overwritten by full
  --help             Show this message and exit.

at2 test-connection

Test your connection to your clients.

Usage:

at2 test-connection [OPTIONS]

Options:

  -l, --client TEXT  Check a specific client
  --help             Show this message and exit.