Skip to content

Commit c98b26a

Browse files
shutter-service: added readme files
1 parent f6dc1a2 commit c98b26a

5 files changed

+121
-0
lines changed

rolling-shutter/docs/rolling-shutter.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ A collection of commands to run and interact with Rolling Shutter nodes
2121
* [rolling-shutter op-bootstrap](rolling-shutter_op-bootstrap.md) - Bootstrap validator utility functions for a shuttermint chain
2222
* [rolling-shutter op-keyper](rolling-shutter_op-keyper.md) - Run a Shutter optimism keyper node
2323
* [rolling-shutter p2pnode](rolling-shutter_p2pnode.md) - Run a Shutter p2p bootstrap node
24+
* [rolling-shutter shutterservice](rolling-shutter_shutterservice.md) - Run a Shutter keyper for Shutter Service
2425
* [rolling-shutter snapshot](rolling-shutter_snapshot.md) - Run the Snapshot Hub communication module
2526
* [rolling-shutter snapshotkeyper](rolling-shutter_snapshotkeyper.md) - Run a Shutter snapshotkeyper node
2627

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
## rolling-shutter shutterservice
2+
3+
Run a Shutter keyper for Shutter Service
4+
5+
### Synopsis
6+
7+
This command runs a keyper node. It will connect to both a Shutter service and a
8+
Shuttermint node which have to be started separately in advance.
9+
10+
```
11+
rolling-shutter shutterservice [flags]
12+
```
13+
14+
### Options
15+
16+
```
17+
--config string config file
18+
-h, --help help for shutterservice
19+
```
20+
21+
### Options inherited from parent commands
22+
23+
```
24+
--logformat string set log format, possible values: min, short, long, max (default "long")
25+
--loglevel string set log level, possible values: warn, info, debug (default "info")
26+
--no-color do not write colored logs
27+
```
28+
29+
### SEE ALSO
30+
31+
* [rolling-shutter](rolling-shutter.md) - A collection of commands to run and interact with Rolling Shutter nodes
32+
* [rolling-shutter shutterservice dump-config](rolling-shutter_shutterservice_dump-config.md) - Dump a 'shutterservice' configuration file, based on given config and env vars
33+
* [rolling-shutter shutterservice generate-config](rolling-shutter_shutterservice_generate-config.md) - Generate a 'shutterservice' configuration file
34+
* [rolling-shutter shutterservice initdb](rolling-shutter_shutterservice_initdb.md) - Initialize the database of the 'shutterservice'
35+
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## rolling-shutter shutterservice dump-config
2+
3+
Dump a 'shutterservice' configuration file, based on given config and env vars
4+
5+
```
6+
rolling-shutter shutterservice dump-config [flags]
7+
```
8+
9+
### Options
10+
11+
```
12+
--config string config file
13+
-f, --force overwrite existing file
14+
-h, --help help for dump-config
15+
--output string output file
16+
```
17+
18+
### Options inherited from parent commands
19+
20+
```
21+
--logformat string set log format, possible values: min, short, long, max (default "long")
22+
--loglevel string set log level, possible values: warn, info, debug (default "info")
23+
--no-color do not write colored logs
24+
```
25+
26+
### SEE ALSO
27+
28+
* [rolling-shutter shutterservice](rolling-shutter_shutterservice.md) - Run a Shutter keyper for Shutter Service
29+
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## rolling-shutter shutterservice generate-config
2+
3+
Generate a 'shutterservice' configuration file
4+
5+
```
6+
rolling-shutter shutterservice generate-config [flags]
7+
```
8+
9+
### Options
10+
11+
```
12+
-f, --force overwrite existing file
13+
-h, --help help for generate-config
14+
--output string output file
15+
```
16+
17+
### Options inherited from parent commands
18+
19+
```
20+
--config string config file
21+
--logformat string set log format, possible values: min, short, long, max (default "long")
22+
--loglevel string set log level, possible values: warn, info, debug (default "info")
23+
--no-color do not write colored logs
24+
```
25+
26+
### SEE ALSO
27+
28+
* [rolling-shutter shutterservice](rolling-shutter_shutterservice.md) - Run a Shutter keyper for Shutter Service
29+
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
## rolling-shutter shutterservice initdb
2+
3+
Initialize the database of the 'shutterservice'
4+
5+
```
6+
rolling-shutter shutterservice initdb [flags]
7+
```
8+
9+
### Options
10+
11+
```
12+
-h, --help help for initdb
13+
```
14+
15+
### Options inherited from parent commands
16+
17+
```
18+
--config string config file
19+
--logformat string set log format, possible values: min, short, long, max (default "long")
20+
--loglevel string set log level, possible values: warn, info, debug (default "info")
21+
--no-color do not write colored logs
22+
```
23+
24+
### SEE ALSO
25+
26+
* [rolling-shutter shutterservice](rolling-shutter_shutterservice.md) - Run a Shutter keyper for Shutter Service
27+

0 commit comments

Comments
 (0)