celogeek/piwigo-cli
1
0
Fork 0
mirror of https://github.com/celogeek/piwigo-cli.git synced 2025-05-25 02:02:37 +02:00
Code Issues Projects Releases Wiki Activity

add images list doc

Browse Source
This commit is contained in:
Celogeek 2022-01-07 08:53:38 +01:00
parent 8040081cfe
commit 1d9577448f
Signed by: celogeek
GPG Key ID: E6B7BDCFC446233A
4 changed files with 102 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
cmd/piwigo-cli/doc.go
View File

@ -1,21 +1,23 @@
// Piwigo Cli /*
// Piwigo Cli
// This tools allow you to interact with your Piwigo Instance.
// Installation: This tools allow you to interact with your Piwigo Instance.
// go install github.com/celogeek/piwigo-cli/cmd/piwigo-cli@latest Installation:
// go install github.com/celogeek/piwigo-cli/cmd/piwigo-cli@latest
// Help
// Help
// To get help:
// piwigo-cli -h To get help:
// piwigo-cli -h
// QuickStart
// QuickStart
// Login
// Login
// First connect to your instance:
// piwigo-cli session login -u URL -l USER -p PASSWORD First connect to your instance:
// piwigo-cli session login -u URL -l USER -p PASSWORD
// Then check your status
// piwigo-cli session status Then check your status
piwigo-cli session status
*/
package main package main

55
cmd/piwigo-cli/general.go
View File

@ -1,27 +1,34 @@
// General Commands /*
// General Commands
// getinfos
// General commands
// piwigo-cli getinfos
// $ piwigo-cli getinfos
// General information of your instance.
// ┌───────────────────┬─────────────────────┐ GetInfos Command
// │ KEY │ VALUE │
// ├───────────────────┼─────────────────────┤ General information of your instance.
// │ version │ 12.2.0 │
// │ nb_elements │ 39664 │ $ piwigo-cli getinfos
// │ nb_categories │ 816 │
// │ nb_virtual │ 816 │ ┌───────────────────┬─────────────────────┐
// │ nb_physical │ 0 │ │ KEY │ VALUE │
// │ nb_image_category │ 39714 │ ├───────────────────┼─────────────────────┤
// │ nb_tags │ 73 │ │ version │ 12.2.0 │
// │ nb_image_tag │ 24024 │ │ nb_elements │ 39664 │
// │ nb_users │ 3 │ │ nb_categories │ 816 │
// │ nb_groups │ 1 │ │ nb_virtual │ 816 │
// │ nb_comments │ 0 │ │ nb_physical │ 0 │
// │ first_date │ 2021-08-27 20:15:15 │ │ nb_image_category │ 39714 │
// │ cache_size │ 4242 │ │ nb_tags │ 73 │
// └───────────────────┴─────────────────────┘ │ nb_image_tag │ 24024 │
│ nb_users │ 3 │
│ nb_groups │ 1 │
│ nb_comments │ 0 │
│ first_date │ 2021-08-27 20:15:15 │
│ cache_size │ 4242 │
└───────────────────┴─────────────────────┘
*/
package main package main
import ( import (

12
cmd/piwigo-cli/images.go
View File

@ -1,3 +1,15 @@
/*
Images Group Commands
This is a group of commands to manipulate the images:
piwigo-cli images list
piwigo-cli images details
piwigo-cli images upload
piwigo-cli images upload-tree
piwigo-cli images tag
*/
package main package main
type ImagesGroup struct { type ImagesGroup struct {

37
cmd/piwigo-cli/images_list.go
View File

@ -1,3 +1,40 @@
/*
Images List Command
List the images of a category.
Recursive list:
$ piwigo-cli images list -r
Category1/SubCategory1/IMG_00001.jpeg
Category1/SubCategory1/IMG_00002.jpeg
Category1/SubCategory1/IMG_00003.jpeg
Category1/SubCategory1/IMG_00004.jpeg
Category1/SubCategory2/IMG_00005.jpeg
Category1/SubCategory2/IMG_00006.jpeg
Category2/SubCategory1/IMG_00007.jpeg
Specify a category:
$ piwigo-cli images list -r -c 2
Category2/SubCategory1/IMG_00007.jpeg
Tree view:
$ piwigo-cli images list -r -c 1 -t
.
├── SubCategory1
│   ├── IMG_00001.jpeg
│   ├── IMG_00002.jpeg
│   ├── IMG_00003.jpeg
│   └── IMG_00004.jpeg
└── SubCategory2
├── IMG_00005.jpeg
└── IMG_00006.jpeg
*/
package main package main
import ( import (