forked/osxphotos
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated help text

Browse Source
This commit is contained in:
Rhet Turnbull 2019-08-24 08:01:53 -07:00
parent 42bc929142
commit e9a4de447c
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -25,6 +25,9 @@ This module will install a command line utility called `osxphotos` that allows y
If you only care about the command line tool, I recommend installing with [pipx](https://github.com/pipxproject/pipx) If you only care about the command line tool, I recommend installing with [pipx](https://github.com/pipxproject/pipx)
After install pipx:
`pipx install osxphotos`
``` ```
Usage: osxphotos [OPTIONS] COMMAND [ARGS]... Usage: osxphotos [OPTIONS] COMMAND [ARGS]...
@ -46,8 +49,6 @@ Commands:
To get help on a specific command, use `osxphotos help <command_name>` To get help on a specific command, use `osxphotos help <command_name>`
``` ```
$ osxphotos help query
Usage: osxphotos help [OPTIONS] Usage: osxphotos help [OPTIONS]
query the Photos database using 1 or more search options query the Photos database using 1 or more search options
@ -57,8 +58,13 @@ Options:
--person TEXT search for person(s) --person TEXT search for person(s)
--album TEXT search for album(s) --album TEXT search for album(s)
--uuid TEXT search for UUID(s) --uuid TEXT search for UUID(s)
-h, --help Show this message and exit. --json Print output in JSON format
``` -h, --help Show this message and exit.
```
Example: find all photos with keyword "Kids" and output results to json file named results.json:
`osxphotos query --keyword Kids --json >results.json`
## Example uses of the module ## Example uses of the module