Options

usage: ndx [-h] [-r] [--explicit] [--max-depth MAX_DEPTH] [--max-files MAX_FILES] [--timeout TIMEOUT] [-f] [-v] [--version]
        directory

Builds index for directories. Annotates the index with data from .ndx.json file.

positional arguments:
directory             path to the target directory

options:
-h, --help            show this help message and exit
-r, --recursive       build index files recursively (default: False)
--explicit            explicitly link to index.html files when linking to directories (default: False)
--max-depth MAX_DEPTH
                        maximum recursion depth (levels below the target directory) for building index files (default: 50)
--max-files MAX_FILES
                        maximum number of entries to process for each index (default: 10000)
--timeout TIMEOUT     timeout for symlink stat and path resolution while processing files for the index (in seconds) (default:
                        10)
-f, --force           overwrite existing index.html file(s) (default: False)
-v, --verbose         enable verbose logging (default: False)
--version             show program's version number and exit

Schema

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "properties": {
        "page": {
            "type": "object",
            "properties": {
                "description": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 10000
                }
            },
            "required": ["description"],
            "additionalProperties": false
        },
        "files": {
            "type": "array",
            "minItems": 1,
            "maxItems": 10000,
            "items": {
                "type": "object",
                "properties": {
                    "name_regex": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 200,
                        "format": "re2-pattern"
                    },
                    "description": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 1000
                    },
                },
                "required": ["name_regex", "description"],
                "additionalProperties": false
            }
        }
    },
    "required": ["page"],
    "additionalProperties": false
}

Examples

{
  "page": {
    "description": "Index page with minimal config file (no file-level description)."
  }
}

{
    "page": {
    "description": "Index page with description and a <a href='https://example.com'>link</a>."
    },
    "files": [
    {
        "name_regex": ".*\\.pdf$",
        "description": "File descriptions can also have <a href='https://example.com'>links</a>"
    },
    {
        "name_regex": "\\.tar",
        "description": "Regex patterns do not need to match the full file name. For example, this description will be applied to both *.tar and *.tar.gz files."
    }
    ]
}