start writing doc

cmd/piwigo-cli/doc.go

@@ -0,0 +1,25 @@
+// Copyright 2011 Celogeek. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+//
+// Piwigo Cli
+//
+// This tools allow you to interact with your Piwigo Instance.
+// Installation:
+//  go get github.com/celogeek/piwigo-cli/cmd/piwigo-cli
+//
+// 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

cmd/piwigo-cli/general.go

@@ -1,3 +1,27 @@
+// 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                │
+//  └───────────────────┴─────────────────────┘
 package main
 
 import (