github.com/hechain20/hechain@v0.0.0-20220316014945-b544036ba106/docs/source/commands/cryptogen.md (about)

     1  <!---
     2   File generated by help_docs.sh. DO NOT EDIT.
     3   Please make changes to preamble and postscript wrappers as appropriate.
     4   --->
     5  
     6  # cryptogen
     7  
     8  `cryptogen` is an utility for generating Hechain key material.
     9  It is provided as a means of preconfiguring a network for testing purposes.
    10  It would normally not be used in the operation of a production network.
    11  
    12  ## Syntax
    13  
    14  The ``cryptogen`` command has five subcommands, as follows:
    15  
    16    * help
    17    * generate
    18    * showtemplate
    19    * extend
    20    * version
    21  
    22  ## cryptogen help
    23  ```
    24  usage: cryptogen [<flags>] <command> [<args> ...]
    25  
    26  Utility for generating Hechain key material
    27  
    28  Flags:
    29    --help  Show context-sensitive help (also try --help-long and --help-man).
    30  
    31  Commands:
    32    help [<command>...]
    33      Show help.
    34  
    35    generate [<flags>]
    36      Generate key material
    37  
    38    showtemplate
    39      Show the default configuration template
    40  
    41    version
    42      Show version information
    43  
    44    extend [<flags>]
    45      Extend existing network
    46  ```
    47  
    48  
    49  ## cryptogen generate
    50  ```
    51  usage: cryptogen generate [<flags>]
    52  
    53  Generate key material
    54  
    55  Flags:
    56    --help                    Show context-sensitive help (also try --help-long
    57                              and --help-man).
    58    --output="crypto-config"  The output directory in which to place artifacts
    59    --config=CONFIG           The configuration template to use
    60  ```
    61  
    62  
    63  ## cryptogen showtemplate
    64  ```
    65  usage: cryptogen showtemplate
    66  
    67  Show the default configuration template
    68  
    69  Flags:
    70    --help  Show context-sensitive help (also try --help-long and --help-man).
    71  ```
    72  
    73  
    74  ## cryptogen extend
    75  ```
    76  usage: cryptogen extend [<flags>]
    77  
    78  Extend existing network
    79  
    80  Flags:
    81    --help                   Show context-sensitive help (also try --help-long and
    82                             --help-man).
    83    --input="crypto-config"  The input directory in which existing network place
    84    --config=CONFIG          The configuration template to use
    85  ```
    86  
    87  
    88  ## cryptogen version
    89  ```
    90  usage: cryptogen version
    91  
    92  Show version information
    93  
    94  Flags:
    95    --help  Show context-sensitive help (also try --help-long and --help-man).
    96  ```
    97  
    98  ## Usage
    99  
   100  Here's an example using the different available flags on the ``cryptogen extend``
   101  command.
   102  
   103  ```
   104      cryptogen extend --input="crypto-config" --config=config.yaml
   105  
   106      org3.example.com
   107  ```
   108  
   109  Where config.yaml adds a new peer organization called ``org3.example.com``
   110  
   111  <a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.