Documentation created automatically

Author: aborroy

.gitignore

@@ -19,3 +19,7 @@
 
 # Go workspace file
 go.work
+
+# Runtime configuration files
+.alfresco
+alfresco.log

Makefile

@@ -4,9 +4,9 @@ LINUX=$(EXECUTABLE)_linux_amd64
 DARWIN=$(EXECUTABLE)_darwin_arm64
 VERSION=$(shell git describe --tags --always --long --dirty)
 
-.PHONY: all test clean
+.PHONY: all test clean docs
 
-all: test build
+all: test build docs
 
 build: test windows linux darwin
 	@echo version: $(VERSION)
@@ -29,6 +29,9 @@ $(DARWIN):
 test:
 	cd test && ./test_node.sh
 
+docs:
+	go build ./docs/generate/generate.go && cd docs/generate && ./generate
+
 clean:
 	go clean
 	rm -f $(WINDOWS) $(LINUX) $(DARWIN)

README.md

@@ -171,13 +171,15 @@ a8e32ff6-6140-4a19-84a5-c157820fc376
 
 Sample bash scripts for testing purposes are provided in [test](test) folder.
 
+## Documentation
+
+Detailed documentation is available in [docs/alfresco.md](docs/alfresco.md)
+
 ## TODO
 
-* Automated testing
 * Site commands
 * Person commands
 * Group commands
 * Search commands
 * Provide pre-built programs for Windows, Linux, Mac AMD64 & Mac ARM64
-* Control concurrency rate
-* [Generate documentation automatically](https://github.com/spf13/cobra/blob/main/doc/md_docs.md)
+* Control concurrency rate

cmd/config/config.go

@@ -7,7 +7,10 @@ import (
 
 var ConfigCmd = &cobra.Command{
 	Use:   "config",
-	Short: "Connection details",
+	Short: "Manage ACS connection details",
+	Long: `ACS Client configuration is stored on a local ".alfresco" file.
+Credentials (username and password) are stored on a Native Store depending on the OS.
+The access to the Native Store may require typing OS credentials.`,
 }
 
 func init() {

cmd/config/delete.go

@@ -13,7 +13,9 @@ const ConfigDeleteCmdId string = "[CONFIG DELETE]"
 
 var configDeleteCmd = &cobra.Command{
 	Use:   "delete",
-	Short: "Connection details removal",
+	Short: "ACS connection details removal",
+	Long: `ACS Client configuration is removed from local ".alfresco" file.
+Credentials (username and password) are removed from Native Store.`,
 	Run: func(command *cobra.Command, args []string) {
 		storedServer := viper.GetString(nativestore.UrlLabel)
 		_err := nativestore.Delete(storedServer)

cmd/config/get.go

@@ -14,7 +14,9 @@ const ConfigGetCmdId string = "[CONFIG GET]"
 
 var configGetCmd = &cobra.Command{
 	Use:   "get",
-	Short: "Get connection details",
+	Short: "Get ACS connection details",
+	Long: `ACS Client configuration and credentials are retrieved.
+The access to the Native Store may require typing OS credentials.`,
 	Run: func(command *cobra.Command, args []string) {
 		storedServer := viper.GetString(nativestore.UrlLabel)
 		username, password, _err := nativestore.Get(storedServer)

cmd/config/set.go

@@ -19,7 +19,11 @@ var insecure bool
 var maxItems int
 var configSetCmd = &cobra.Command{
 	Use:   "set",
-	Short: "Connection details storage",
+	Short: "ACS connection details storage",
+	Long: `ACS Client configuration is stored on a local ".alfresco" file.
+Credentials (username and password) are stored on a Native Store depending on the OS.
+The access to the Native Store may require typing OS credentials.
+When using TLS, "insecure" flag can be set to "true" to allow connections to ACS servers using self-signed certificates.`,
 	Run: func(command *cobra.Command, args []string) {
 		_err := nativestore.Set(server, username, password)
 		if _err != nil {

cmd/node/create.go

@@ -78,7 +78,10 @@ var propertiesCreate []string
 var fileNameCreate string
 var nodeCreateCmd = &cobra.Command{
 	Use:   "create",
-	Short: "Create new Node",
+	Short: "Create new Node in ACS Repository",
+	Long: `Creates a new node as children of a parent node in the repository.
+The node can be created setting only metadata (name, type, aspects and properties) or
+a local file can be also specified to be associated as the content of the new node.`,
 	Run: func(command *cobra.Command, args []string) {
 		CreateNode(nodeId,
 			nodeNameCreate,
@@ -96,12 +99,12 @@ var nodeCreateCmd = &cobra.Command{
 
 func init() {
 	nodeCmd.AddCommand(nodeCreateCmd)
-	nodeCreateCmd.Flags().StringVarP(&nodeId, "nodeId", "i", "", "Parent Node Id in Alfresco Repository. The node is created under this Parent Node. You can also use one of these well-known aliases: -my-, -shared-, -root-")
-	nodeCreateCmd.Flags().StringVarP(&relativePath, "relativePath", "r", "", "A path in Alfresco Repository relative to the nodeId.")
-	nodeCreateCmd.Flags().StringVarP(&nodeNameCreate, "name", "n", "", "Node Name")
-	nodeCreateCmd.Flags().StringVarP(&nodeTypeCreate, "type", "t", "", "Node Type")
-	nodeCreateCmd.Flags().StringArrayVarP(&aspectsCreate, "aspects", "a", nil, "Complete aspect list to be set")
-	nodeCreateCmd.Flags().StringArrayVarP(&propertiesCreate, "properties", "p", nil, "Property=Value list containing properties to be updated")
+	nodeCreateCmd.Flags().StringVarP(&nodeId, "nodeId", "i", "", "Parent Node Id in Alfresco Repository (commonly a folder node). The node is created under this Parent Node. You can also use one of these well-known aliases: -my-, -shared-, -root-")
+	nodeCreateCmd.Flags().StringVarP(&relativePath, "relativePath", "r", "", "A path in Alfresco Repository relative to the nodeId for the Parent Node.")
+	nodeCreateCmd.Flags().StringVarP(&nodeNameCreate, "name", "n", "", "New Node Name")
+	nodeCreateCmd.Flags().StringVarP(&nodeTypeCreate, "type", "t", "", "New Node Type")
+	nodeCreateCmd.Flags().StringArrayVarP(&aspectsCreate, "aspects", "a", nil, "Complete aspect list to be set for the New Node")
+	nodeCreateCmd.Flags().StringArrayVarP(&propertiesCreate, "properties", "p", nil, "Property=Value list containing properties to be created for the New Node")
 	nodeCreateCmd.Flags().StringVarP(&fileNameCreate, "file", "f", "", "Filename to be uploaded (complete or local path)")
 	nodeCreateCmd.Flags().SortFlags = false
 	nodeCreateCmd.MarkFlagRequired("nodeId")

cmd/node/delete.go

@@ -13,7 +13,9 @@ const DeleteNodeCmdId string = "[NODE DELETE]"
 
 var nodeDeleteCmd = &cobra.Command{
 	Use:   "delete",
-	Short: "Delete Node",
+	Short: "Delete a Node existing in the repository",
+	Long: `Removes an existing node from the repository.
+Both metadata and content resources are removed.`,
 	Run: func(command *cobra.Command, args []string) {
 		if relativePath != "" {
 			nodeId = GetNodeId(nodeId, relativePath)

cmd/node/download-folder.go

@@ -58,7 +58,9 @@ var folderNameDownload string
 var wgDownload sync.WaitGroup
 var nodeDownloadFolderCmd = &cobra.Command{
 	Use:   "download-folder",
-	Short: "Download Alfresco Repository folder to local folder",
+	Short: "Download an Alfresco Repository folder to a local folder",
+	Long: `Folders and files nodes from the repository are retrieved recursively.
+Only content is downloaded, while metadata is not available on the local download`,
 	Run: func(command *cobra.Command, args []string) {
 
 		log.Println(NodeUploadFolderCmdId,
@@ -83,6 +85,6 @@ func init() {
 	nodeCmd.AddCommand(nodeDownloadFolderCmd)
 	nodeDownloadFolderCmd.Flags().StringVarP(&nodeId, "nodeId", "i", "", "Node Id in Alfresco Repository to download to local folder. You can also use one of these well-known aliases: -my-, -shared-, -root-")
 	nodeDownloadFolderCmd.Flags().StringVarP(&relativePath, "relativePath", "r", "", "A path in Alfresco Repository relative to the nodeId.")
-	nodeDownloadFolderCmd.Flags().StringVarP(&folderNameDownload, "directory", "d", "", "Folder to download Alfresco content")
+	nodeDownloadFolderCmd.Flags().StringVarP(&folderNameDownload, "directory", "d", "", "Local folder path to download Alfresco content")
 	nodeDownloadFolderCmd.MarkFlagRequired("nodeId")
 }