github.com/decred/politeia@v1.4.0/politeiawww/cmd/cmswww/README.md (about)

     1  # cmswww
     2  
     3  cmswww is a command line tool that allows you to interact with the cmswww API.
     4  
     5  ## Available Commands
     6  You can view the available commands and application options by using the help
     7  flag.
     8  
     9      $ cmswww -h 
    10  
    11  You can view details about a specific command, including required arguments,
    12  by using the help command.
    13  
    14      $ cmswww help <command>
    15  
    16  ## Persisting Data Between Commands
    17  cmswww stores  user identity data (the user's public/private key pair), session
    18  cookies, and CSRF tokens in the cmswww directory.  This allows you to login
    19  with a user and use the same session data for subsequent commands.  The data is
    20  segmented by host, allowing you to login and interact with multiple hosts
    21  simultaneously.
    22  
    23  The location of the cmswww directory varies based on your operating system.
    24  
    25  **macOS**
    26  
    27  `/Users/<username>/Library/Application Support/Cmswww`
    28  
    29  **Windows**
    30  
    31  `C:\Users\<username>\AppData\Local\Cmswww`
    32  
    33  **Ubuntu**
    34  
    35  `~/.cmswww`
    36  
    37  ## Setup Configuration File
    38  cmswww has a configuration file that you can setup to make execution easier.
    39  You should create the configuration file under the following paths.
    40  
    41  **macOS**
    42  
    43  `/Users/<username>/Library/Application Support/Piwww/cmswww.conf`
    44  
    45  **Windows**
    46  
    47  `C:\Users\<username>\AppData\Local\Piwww/cmswww.conf`
    48  
    49  **Ubuntu**
    50  
    51  `~/.cmswww/cmswww.conf`
    52  
    53  If you're developing locally, you'll want to set the politeiawww host in the
    54  configuration file since the default politeiawww host is
    55  `https://proposals.decred.org`.  Copy these lines into your `cmswww.conf` file.
    56  `skipverify` is used to skip TLS certificate verification and should only be
    57  used when running politeia locally.
    58  
    59  ```
    60  host=https://127.0.0.1:4443
    61  skipverify=true
    62  ```