datalad catalog-serve
Synopsis
datalad catalog-serve [-h] [-c CATALOG] [--port PORT] [--base BASE] [--version]
Description
Start a local http server to render and test a local catalog.
Optional arguments include a custom port.
Examples
SERVE the content of the catalog via a local HTTP server:
% datalad catalog-serve -c /tmp/my-cat
SERVE the content of the catalog via a local HTTP server at a custom port, e.g. http://localhost:8001:
% datalad catalog-serve -c /tmp/my-cat -p 8001
SERVE the content of the catalog via a local HTTP server at a custom subdirectory, e.g. http://localhost:8000/my-cat:
% datalad catalog-serve -c /tmp/my-cat --base /tmp
Options
-h, --help, --help-np
show this help message. --help-np forcefully disables the use of a pager for displaying the help message
-c CATALOG, --catalog CATALOG
Location of the existing catalog to be served.
--port PORT
The port at which the content is served at 'localhost' (default 8000). [Default: 8000]
--base BASE
The base path that should be served as the 'localhost' root, implying that the catalog will be served from a subdirectory relative to the base path. Must be a parent path of the catalog location.
--version
show the module and its version which provides the command