From 66019761ff8e100fa580f45f032e652b982d8f30 Mon Sep 17 00:00:00 2001
From: kirillston <stonozhenko@anytype.io>
Date: Mon, 25 Sep 2023 18:46:29 +0200
Subject: [PATCH] GO-1890 Rename CLI tools

---
 README.md                                                  | 4 ++--
 cmd/{archiveconverter => archiveunpacker}/main.go          | 0
 cmd/{archiveprocessor => usecasegenerator}/excluded.go     | 0
 cmd/{archiveprocessor => usecasegenerator}/excluded.json   | 0
 cmd/{archiveprocessor => usecasegenerator}/main.go         | 0
 cmd/{archiveprocessor => usecasegenerator}/rules.go        | 0
 cmd/{archiveprocessor => usecasegenerator}/rules.json      | 0
 cmd/{archiveprocessor => usecasegenerator}/validators.go   | 0
 .../README.md => docs/ExportArchiveUnpacker.md             | 4 ++--
 cmd/archiveprocessor/README.md => docs/UsecaseGenerator.md | 7 +++++--
 10 files changed, 9 insertions(+), 6 deletions(-)
 rename cmd/{archiveconverter => archiveunpacker}/main.go (100%)
 rename cmd/{archiveprocessor => usecasegenerator}/excluded.go (100%)
 rename cmd/{archiveprocessor => usecasegenerator}/excluded.json (100%)
 rename cmd/{archiveprocessor => usecasegenerator}/main.go (100%)
 rename cmd/{archiveprocessor => usecasegenerator}/rules.go (100%)
 rename cmd/{archiveprocessor => usecasegenerator}/rules.json (100%)
 rename cmd/{archiveprocessor => usecasegenerator}/validators.go (100%)
 rename cmd/archiveconverter/README.md => docs/ExportArchiveUnpacker.md (88%)
 rename cmd/archiveprocessor/README.md => docs/UsecaseGenerator.md (85%)

diff --git a/README.md b/README.md
index f61c002a7..b41a9fe39 100644
--- a/README.md
+++ b/README.md
@@ -14,8 +14,8 @@ Current main branch doesn't work with the production any-sync nodes. For now, yo
 - [Project workflows](docs/Flow.md)
 
 ### CLI tools
-- [Archive processor](cmd/archiveprocessor/README.md)
-- [Archive converter](cmd/archiveconverter/README.md)
+- [Usecase generator](docs/UsecaseGenerator.md)
+- [Export Archive unpacker](docs/ExportArchiveUnpacker.md)
 
 ## Contribution
 Thank you for your desire to develop Anytype together!
diff --git a/cmd/archiveconverter/main.go b/cmd/archiveunpacker/main.go
similarity index 100%
rename from cmd/archiveconverter/main.go
rename to cmd/archiveunpacker/main.go
diff --git a/cmd/archiveprocessor/excluded.go b/cmd/usecasegenerator/excluded.go
similarity index 100%
rename from cmd/archiveprocessor/excluded.go
rename to cmd/usecasegenerator/excluded.go
diff --git a/cmd/archiveprocessor/excluded.json b/cmd/usecasegenerator/excluded.json
similarity index 100%
rename from cmd/archiveprocessor/excluded.json
rename to cmd/usecasegenerator/excluded.json
diff --git a/cmd/archiveprocessor/main.go b/cmd/usecasegenerator/main.go
similarity index 100%
rename from cmd/archiveprocessor/main.go
rename to cmd/usecasegenerator/main.go
diff --git a/cmd/archiveprocessor/rules.go b/cmd/usecasegenerator/rules.go
similarity index 100%
rename from cmd/archiveprocessor/rules.go
rename to cmd/usecasegenerator/rules.go
diff --git a/cmd/archiveprocessor/rules.json b/cmd/usecasegenerator/rules.json
similarity index 100%
rename from cmd/archiveprocessor/rules.json
rename to cmd/usecasegenerator/rules.json
diff --git a/cmd/archiveprocessor/validators.go b/cmd/usecasegenerator/validators.go
similarity index 100%
rename from cmd/archiveprocessor/validators.go
rename to cmd/usecasegenerator/validators.go
diff --git a/cmd/archiveconverter/README.md b/docs/ExportArchiveUnpacker.md
similarity index 88%
rename from cmd/archiveconverter/README.md
rename to docs/ExportArchiveUnpacker.md
index f65d38412..9781d2f92 100644
--- a/cmd/archiveconverter/README.md
+++ b/docs/ExportArchiveUnpacker.md
@@ -1,10 +1,10 @@
-## Exported archives converter tool
+## Exported Archives unpacking tool
 
 Anytype allows user to export desired objects whether in _JSON_ or _PROTOBUF_ formats. 
 
 Most of exported archives contain objects stored in _PROTOBUF_ format, as it is encoded and lightweight. However, if you need to convert an exported archive to see all objects in _JSON_ format you can use **archiveconverter** tool.
 
-CLI can run in two modes.
+Program is located in [cmd/archiveunpacker](../cmd/archiveunpacker) folder. CLI can run in two modes:
 
 ### Unpack
 ```bash
diff --git a/cmd/archiveprocessor/README.md b/docs/UsecaseGenerator.md
similarity index 85%
rename from cmd/archiveprocessor/README.md
rename to docs/UsecaseGenerator.md
index 2b82da022..b0a033513 100644
--- a/cmd/archiveprocessor/README.md
+++ b/docs/UsecaseGenerator.md
@@ -1,11 +1,13 @@
-## Use Case archives processing tool
+## Use Case archives generating tool
 
-To use Use Case archives processing tool build the program
+To use Use Case archives processing tool head to [cmd/usecasegenerator](../cmd/usecasegenerator), build the program
 `go build`
 and run it using
 `./archiveprocessor <path_to_archive>`
 command.
 
+Program accepts only one parameter - path to the archive containing exported objects from space.
+
 If all protobuf objects contain correct information, resulting archive would be written in **<path_to_archive>_new.zip** file in same directory.
 
 If objects in archive have some incorrect information, e.g.:
@@ -19,6 +21,7 @@ then program provides you with error messages in the output along with the list
 Incorrect data found by tool could be resolved two different ways:
 1. Via editor of the client and repetitive export of desired account
 2. Using rules engine
+3. Using Export Archive unpacker tool (see its [docs](ExportArchiveUnpacker.md))
 
 Rules are the actions that could be done upon such entities of smartblock as:
 - relation links