From 1d9577448f1168cded52fb0052b42d8c2c27492f Mon Sep 17 00:00:00 2001
From: celogeek <65178+celogeek@users.noreply.github.com>
Date: Fri, 7 Jan 2022 08:53:38 +0100
Subject: [PATCH] add images list doc

---
 cmd/piwigo-cli/doc.go         | 42 +++++++++++++-------------
 cmd/piwigo-cli/general.go     | 55 ++++++++++++++++++++---------------
 cmd/piwigo-cli/images.go      | 12 ++++++++
 cmd/piwigo-cli/images_list.go | 37 +++++++++++++++++++++++
 4 files changed, 102 insertions(+), 44 deletions(-)

diff --git a/cmd/piwigo-cli/doc.go b/cmd/piwigo-cli/doc.go
index bb590b9..594da29 100644
--- a/cmd/piwigo-cli/doc.go
+++ b/cmd/piwigo-cli/doc.go
@@ -1,21 +1,23 @@
-// Piwigo Cli
-//
-// This tools allow you to interact with your Piwigo Instance.
-// Installation:
-//  go install github.com/celogeek/piwigo-cli/cmd/piwigo-cli@latest
-//
-// Help
-//
-// To get help:
-//  piwigo-cli -h
-//
-// QuickStart
-//
-// Login
-//
-// First connect to your instance:
-//  piwigo-cli session login -u URL -l USER -p PASSWORD
-//
-// Then check your status
-//  piwigo-cli session status
+/*
+Piwigo Cli
+
+This tools allow you to interact with your Piwigo Instance.
+Installation:
+ go install github.com/celogeek/piwigo-cli/cmd/piwigo-cli@latest
+
+Help
+
+To get help:
+ piwigo-cli -h
+
+QuickStart
+
+Login
+
+First connect to your instance:
+ piwigo-cli session login -u URL -l USER -p PASSWORD
+
+Then check your status
+ piwigo-cli session status
+*/
 package main
diff --git a/cmd/piwigo-cli/general.go b/cmd/piwigo-cli/general.go
index fb91bf7..09a18bb 100644
--- a/cmd/piwigo-cli/general.go
+++ b/cmd/piwigo-cli/general.go
@@ -1,27 +1,34 @@
-// General Commands
-//
-// getinfos
-//
-//  piwigo-cli getinfos
-//
-// General information of your instance.
-//  ┌───────────────────┬─────────────────────┐
-//  │ KEY               │ VALUE               │
-//  ├───────────────────┼─────────────────────┤
-//  │ version           │ 12.2.0              │
-//  │ nb_elements       │ 39664               │
-//  │ nb_categories     │ 816                 │
-//  │ nb_virtual        │ 816                 │
-//  │ nb_physical       │ 0                   │
-//  │ nb_image_category │ 39714               │
-//  │ 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                │
-//  └───────────────────┴─────────────────────┘
+/*
+General Commands
+
+General commands
+
+	$ piwigo-cli getinfos
+
+GetInfos Command
+
+General information of your instance.
+
+	$ piwigo-cli getinfos
+
+	┌───────────────────┬─────────────────────┐
+	│ KEY               │ VALUE               │
+	├───────────────────┼─────────────────────┤
+	│ version           │ 12.2.0              │
+	│ nb_elements       │ 39664               │
+	│ nb_categories     │ 816                 │
+	│ nb_virtual        │ 816                 │
+	│ nb_physical       │ 0                   │
+	│ nb_image_category │ 39714               │
+	│ 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
 
 import (
diff --git a/cmd/piwigo-cli/images.go b/cmd/piwigo-cli/images.go
index 30fead8..d375edf 100644
--- a/cmd/piwigo-cli/images.go
+++ b/cmd/piwigo-cli/images.go
@@ -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
 
 type ImagesGroup struct {
diff --git a/cmd/piwigo-cli/images_list.go b/cmd/piwigo-cli/images_list.go
index e88454f..f2046b2 100644
--- a/cmd/piwigo-cli/images_list.go
+++ b/cmd/piwigo-cli/images_list.go
@@ -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
 
 import (