thefox/flickr-cli

Upload and download Flickr photos, photo sets, directories via shell.

FlickrCLI

A command-line interface to Flickr. Upload and download photos, photo sets, directories via shell., _(*1)

Installation

1. Clone from Github:, _(*2)

   git clone https://github.com/TheFox/flickr-cli.git

2. Install dependencies:, _(*3)

   composer install

3. Go to https://www.flickr.com/services/apps/create/apply/ to create a new API key. The first time you run ./bin/flickr-cli auth you'll be prompted to enter your new consumer key and secret., _(*4)

Usage

First, get the access token:, _(*5)

./bin/flickr-cli auth

Upload

./bin/flickr-cli upload [-d DESCRIPTION] [-t TAG,...] [-s SET,...] DIRECTORY...

Download

./bin/flickr-cli download -d DIRECTORY [SET...]

To download all photosets to directory photosets:, _(*6)

./bin/flickr-cli download -d photosets

Or to download only the photoset Holiday 2013:, _(*7)

./bin/flickr-cli download -d photosets 'Holiday 2013'

To download all photos into directories named by photo ID (and so which will not change when you rename albums or photos; perfect for a complete Flickr backup) you can use the --id-dirs option:, _(*8)

./bin/flickr-cli download -d flickr_backup --id-dirs

This creates a stable directory structure of the form destination_dir/hash/hash/photo-ID/ and saves the full original photo file along with a metadata.yml file containing all photo metadata. The hashes, which are the first two sets of two characters of the MD5 hash of the ID, are required in order to prevent a single directory from containing too many subdirectories (to avoid problems with some filesystems)., _(*9)

Usage of the Docker Image

Setup

To use this software within Docker follow this steps., _(*10)

1. Create a volume. This is used to store the configuration file for the auth step., _(*11)

   docker volume create flickrcli

2. Get the access token (it will create config.yml file in the volume)., _(*12)

   docker run --rm -it -u $(id -u):$(id -g) -v "$PWD":/mnt -v flickrcli:/data thefox21/flickr-cli auth

   or you can store the config.yml in your $HOME/.flickr-cli directory and use:, _(*13)

   mkdir $HOME/.flickr-cli
   docker run --rm -it -u $(id -u):$(id -g) -v "$PWD":/mnt -v "$HOME/.flickr-cli":/data thefox21/flickr-cli auth

Usage

Upload directory 2017.06.01-Spindleruv_mlyn full of JPEGs to Flickr:, _(*14)

docker run --rm -it -u $(id -u):$(id -g) -v "$PWD":/mnt -v flickrcli:/data thefox21/flickr-cli upload --config=/data/config.yml --tags "2017.06.01 Spindleruv_mlyn" --sets "2017.06.01-Spindleruv_mlyn" 2017.06.01-Spindleruv_mlyn

For Docker image troubleshooting you can use:, _(*15)

docker run --rm -it -u $(id -u):$(id -g) -v "$PWD":/mnt -v flickrcli:/data --entrypoint=/bin/bash thefox21/flickr-cli

Paths

• /app - Main Application directory.
• /data - Volume for variable data.
• /mnt - Host system's $PWD.

Documentations

• Flickr API documentation
• Docker documentation

License

Copyright (C) 2016 Christian Mayer https://fox21.at, _(*16)

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version., _(*17)

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/., _(*18)