anyproto/anytype-heart
1
0
Fork 0
mirror of https://github.com/anyproto/anytype-heart.git synced 2025-06-07 21:37:04 +09:00
Code Activity

GO-1890 Rename CLI tools

Browse source
This commit is contained in:
kirillston 2023-09-25 18:46:29 +02:00
parent 898f3243e4
commit 66019761ff
No known key found for this signature in database
GPG key ID: 88218A7F1109754B
10 changed files with 9 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -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!

0
cmd/archiveconverter/main.go → cmd/archiveunpacker/main.go
View file

0
cmd/archiveprocessor/excluded.go → cmd/usecasegenerator/excluded.go
View file

0
cmd/archiveprocessor/excluded.json → cmd/usecasegenerator/excluded.json
View file

0
cmd/archiveprocessor/main.go → cmd/usecasegenerator/main.go
View file

0
cmd/archiveprocessor/rules.go → cmd/usecasegenerator/rules.go
View file

0
cmd/archiveprocessor/rules.json → cmd/usecasegenerator/rules.json
View file

0
cmd/archiveprocessor/validators.go → cmd/usecasegenerator/validators.go
View file

4
cmd/archiveconverter/README.md → docs/ExportArchiveUnpacker.md
View file

@ -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

7
cmd/archiveprocessor/README.md → docs/UsecaseGenerator.md
View file

@ -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