Skip to content

Latest commit

 

History

History
87 lines (54 loc) · 1.71 KB

usage.rst

File metadata and controls

87 lines (54 loc) · 1.71 KB
Raw

Usage

Installation

spsm can be installed using pip:

(.venv) $ pip install spsm
(.venv) $ spsm -v
Simple Python Server Manager, v0.1.2

Quick Start

  1. Create a directory for your server
(.venv) $ mkdir my_server
(.venv) $ cd my_server
  1. Initialize the directory
(.venv) $ spsm init
  1. Add a server jar and apply the new configuration
(.venv) $ spsm upsert -u [jar source url] server server_jar
(.venv) $ spsm jars apply
  1. Activate the server wrapper
(.venv) $ spsm server activate -a

5. Once in the interactive wrapper terminal, use the command start to start the server. help can also be used to list available commands

spsm >> start

Note

Sometimes the output can be initially off by a line or two depending on the size of the terminal. Output can be scrolled up and down using the arrow keys

Note

The server will typically not successfully start the first time as you will have to update the eula.txt

6. The interactive terminal can be exited without terminating the server using the exit command or by pressing CTRL+A CTRL+D

.. seealso::

  The wrapper is managed using the :code:`screen` command.
  see `here <https://www.gnu.org/software/screen/manual/screen.html>`_ for more information on screens.

Commands

.. click:: cli.spsm:spsm
  :prog: spsm
  :commands: init,list
  :nested: full


.. click:: cli.spsm:server
  :prog: spsm server
  :nested: full


.. click:: cli.spsm:jars
  :prog: spsm jars
  :nested: full