Command Line Interface Reference

Important: don't rely on the command names and parameters yet. They will likely change in the future and are not considered stable yet! Also read this section first to find out what commands are there and how they need to be used.

See below for details on each command.

cli

Usage:

cli [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`-d`, `--debug`	boolean	outputs debug information (implies --verbose)	`False`
`-f`, `--force`	boolean	forces the execution of commands and skips confirmation dialogs	`False`
`-v`, `--verbose`	boolean	outputs verbose log information	`False`
`--help`	boolean	Show this message and exit.	`False`

albums

lists existing albums and their ids

Usage:

cli albums [OPTIONS] [NAMES]...

Options:

Name	Type	Description	Default
`-s`, `--shared`	boolean	include shared elements	`False`
`--help`	boolean	Show this message and exit.	`False`

count

counts items

Usage:

cli count [OPTIONS] [PARENT_ID]

Options:

Name	Type	Description	Default
`-a`, `--albums`	boolean	counts the number of albums	`False`
`-f`, `--folders`	boolean	counts the number of folders	`False`
`-i`, `--items`	boolean	counts the number of items	`False`
`--help`	boolean	Show this message and exit.	`False`

create

creates albums

Usage:

cli create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`-f`, `--folder`	text	name of a folder used to populate album	None
`-fid`, `--folder-id`	integer	id of a folder used to populate album	None
`-s`, `--share`	integer	share album with users or groups	None
`--help`	boolean	Show this message and exit.	`False`

download

download items

Usage:

cli download [OPTIONS] ID

Options:

Name	Type	Description	Default
`-d`, `--destination`	text	destination folder for downloaded items	_required
`-s`, `--size`	text	download image in specified size, can be one of [sm, m, xl, original]	`original`
`--help`	boolean	Show this message and exit.	`False`

folders

lists existing folders and their ids

Usage:

cli folders [OPTIONS] [NAME]

Options:

Name	Type	Description	Default
`-p`, `--parent_id`	integer	id of the parent	None
`-r`, `--recursive`	boolean	include all folders recursively	`False`
`--help`	boolean	Show this message and exit.	`False`

groups

lists existing groups and their ids

Usage:

cli groups [OPTIONS]

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

id

helps finding ids of various things

Usage:

cli id [OPTIONS] ELEMENT

Options:

Name	Type	Description	Default
`-a`, `--album`	boolean	search for album id	`False`
`-f`, `--folder`	boolean	search for folder id	`False`
`-g`, `--group`	boolean	search for group id	`False`
`-u`, `--user`	boolean	search for user id	`False`
`--help`	boolean	Show this message and exit.	`False`

init

initializes the application

Usage:

cli init [OPTIONS]

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

items

lists items

Usage:

cli items [OPTIONS] [NAME]

Options:

Name	Type	Description	Default
`-a`, `--album`	integer	id of the parent album	None
`-f`, `--folder`	integer	id of the parent folder	None
`-r`, `--recursive`	boolean	include all folders recursively	`False`
`--help`	boolean	Show this message and exit.	`False`

profile

shows the name of the currently active profile

Usage:

cli profile [OPTIONS]

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

root

gets the id of the root folder

Usage:

cli root [OPTIONS]

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

shares an album

Usage:

cli share [OPTIONS] [NAME]

Options:

Name	Type	Description	Default
`-id`, `--album-id`	integer	id of the album to share, if provided name will be ignored	None
`-r`, `--role`	text	permission role, can be "view", "download" or "upload"	`view`
`-p`, `--public`	boolean	shares the album publicly	`False`
`-g`, `--group`	text	group to share with	None
`-gid`, `--group-id`	text	id of a group to share with	None
`-u`, `--user`	text	user to share with	None
`-uid`, `--user-id`	text	id of a user to share with´	None
`--help`	boolean	Show this message and exit.	`False`

show

displays information on items, folder and albums (this is mainly for development)

Usage:

cli show [OPTIONS] [ID]

Options:

Name	Type	Description	Default
`-a`, `--album-id`	boolean	treat provided id as album id	`False`
`-f`, `--folder-id`	boolean	treat provided id as folder id	`False`
`-i`, `--item-id`	boolean	treat provided id as item id (this is the default)	`False`
`--help`	boolean	Show this message and exit.	`False`

sync

Usage:

cli sync [OPTIONS] [ALBUMS]...

Options:

Name	Type	Description	Default
`-d`, `--destination`	text	destination folder to sync to	_required
`--help`	boolean	Show this message and exit.	`False`

unshare

unshares an album

Usage:

cli unshare [OPTIONS] [NAME]

Options:

Name	Type	Description	Default
`-id`, `--album-id`	integer	id of the album to unshare, if provided, name will be ignored	None
`--help`	boolean	Show this message and exit.	`False`

users

lists existing users and their ids

Usage:

cli users [OPTIONS]

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

version

prints version information

Usage:

cli version [OPTIONS]

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`