Source

tkf.bitbucket.org / neorg-doc / _sources / commands.txt

NEOrg commands
==============

.. admonition:: NEOrg sub-commands

   * init_
   * serve_

.. [[[cog from genecommands import genehelp; genehelp() ]]]

::

    usage: neorg [-h] {init,serve} ...

    NEOrg - Numerical Simulation Organizer

    positional arguments:
      {init,serve}
        init        initialize neorg directory
        serve       start stand-alone webserver

    optional arguments:
      -h, --help    show this help message and exit

.. [[[end]]]


``init``
--------

.. [[[cog from genecommands import genehelp; genehelp('init') ]]]

::

    usage: neorg init [-h] [dest]

    positional arguments:
      dest        root directory to initialize (default: ".")

    optional arguments:
      -h, --help  show this help message and exit

.. [[[end]]]


``serve``
---------

.. [[[cog from genecommands import genehelp; genehelp('serve') ]]]

::

    usage: neorg serve [-h] [-p PORT] [-R ROOT] [-b] [--debug]

    optional arguments:
      -h, --help            show this help message and exit
      -p PORT, --port PORT  port to listen (default: 8000)
      -R ROOT, --root ROOT  root directory (where `.neorg/` exists)
      -b, --browser         open web browser
      --debug               set DEBUG=True to run in debug mode

.. [[[end]]]
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.