SSITE(1)

📦

version 2.5 · 3 versions

2.5 · debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking (latest)
1.4.1 · ubuntu jammy
2.3 · debian bookworm

, in debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

✨ ssite(1) — User Commands, but make it cute 💅

okay bestie, sit down, hydrate, because this is the SSITE(1) page from the User Commands corner of the manual and we are doing the WHOLE thing. no skimming. every flag gets its moment. 🦋

💖 NAME 💖

ssite — that's it. that's the name. ssite. short. iconic. no notes. 👑

🌸 DESCRIPTION 🌸

first thing on the page is the usage, and she is LONG:

       usage: ssite [-h] [--version]

              {check,dump,dump_meta,build,serve,show,new,edit,site,meta,shell}
              ...

and the actual description? Static site generator. that's the whole sentence and honestly it ate. 🔥

🎀 positional arguments 🎀

{check,dump,dump_meta,build,serve,show,new,edit,site,meta,shell} — sub-command help

and here's the list of them, exactly as printed, no cap:

check dump dump_meta build serve show new edit site meta
Edit metadata for a file shell

🎀 options 🎀

-h, --help — show this help message and exit 🫶
--version, -V — show program's version number and exit

🔥 CHECK SUBCOMMAND 🔥

usage, verbatim:

       usage: ssite check [-h] [-v] [--debug] [--theme THEME] [--content
       CONTENT]

              [--archetypes ARCHETYPES] [-o OUTPUT] [--draft]

PROJECT

(yes the section is literally named PROJECT, we love a bold label 💅)

positional arguments

project — project directory or .py configuration file (default: the current directory)

options

-h, --help — show this help message and exit
-v, --verbose — verbose output
--debug — debugging output
--theme THEME — theme directory location. Overrides settings.THEME
--content CONTENT — content directory location. Overrides settings.CONTENT
--archetypes ARCHETYPES — archetypes directory location. Override settings.ARCHETYPES
-o OUTPUT, --output OUTPUT — output directory location. Override settings.OUTPUT
--draft — do not ignore pages with date in the future

🔥 DUMP SUBCOMMAND 🔥

       usage: ssite dump [-h] [-v] [--debug] [--theme THEME] [--content
       CONTENT]

              [--archetypes ARCHETYPES] [-o OUTPUT] [--draft] (--fstree |
              --nodes | --changes | --reference-documentation [destdir])

positional arguments

project — project directory or .py configuration file (default: the current directory)

options

-h, --help — show this help message and exit
-v, --verbose — verbose output
--debug — debugging output
--theme THEME — theme directory location. Overrides settings.THEME
--content CONTENT — content directory location. Overrides settings.CONTENT
--archetypes ARCHETYPES — archetypes directory location. Override settings.ARCHETYPES
-o OUTPUT, --output OUTPUT — output directory location. Override settings.OUTPUT
--draft — do not ignore pages with date in the future
--fstree — dump information about the scanned directory trees
--nodes — dump information about the built site layout
--changes — dump information about pages that changed
--reference-documentation [destdir] — regenerate reference documentation

🔥 DUMP_META SUBCOMMAND 🔥

       usage: ssite dump_meta [-h] [-v] [--debug] [--theme THEME] [--content
       CONTENT]

       [--archetypes ARCHETYPES] [-o OUTPUT] [--draft]
              [-f FORMAT] [-p PAGES [PAGES ...]]

positional arguments

project — project directory or .py configuration file (default: the current directory)

options

-h, --help — show this help message and exit
-v, --verbose — verbose output
--debug — debugging output
--theme THEME — theme directory location. Overrides settings.THEME
--content CONTENT — content directory location. Overrides settings.CONTENT
--archetypes ARCHETYPES — archetypes directory location. Override settings.ARCHETYPES
-o OUTPUT, --output OUTPUT — output directory location. Override settings.OUTPUT
--draft — do not ignore pages with date in the future
-f FORMAT, --format FORMAT — format to use for output
-p PAGES [PAGES ...], --pages PAGES [PAGES ...] — globs or regexps matching pages to show

🔥 BUILD SUBCOMMAND 🔥

       usage: ssite build [-h] [-v] [--debug] [--theme THEME] [--content
       CONTENT]

              [--archetypes ARCHETYPES] [-o OUTPUT] [--draft] [--type TYPE]
              [--path PATH] [--fail-fast] [-f]

positional arguments

project — project directory or .py configuration file (default: the current directory)

options

-h, --help — show this help message and exit
-v, --verbose — verbose output
--debug — debugging output
--theme THEME — theme directory location. Overrides settings.THEME
--content CONTENT — content directory location. Overrides settings.CONTENT
--archetypes ARCHETYPES — archetypes directory location. Override settings.ARCHETYPES
-o OUTPUT, --output OUTPUT — output directory location. Override settings.OUTPUT
--draft — do not ignore pages with date in the future
--type TYPE — render only pages of this type
--path PATH — render only pages under this path
--fail-fast — fail the first time a page gives an error in rendering
-f, --full — always do a full rebuild

🔥 SERVE SUBCOMMAND 🔥

       usage: ssite serve [-h] [-v] [--debug] [--theme THEME] [--content
       CONTENT]

              [--archetypes ARCHETYPES] [-o OUTPUT] [--draft] [--port PORT]
              [--host HOST]

positional arguments

project — project directory or .py configuration file (default: the current directory)

options

-h, --help — show this help message and exit
-v, --verbose — verbose output
--debug — debugging output
--theme THEME — theme directory location. Overrides settings.THEME
--content CONTENT — content directory location. Overrides settings.CONTENT
--archetypes ARCHETYPES — archetypes directory location. Override settings.ARCHETYPES
-o OUTPUT, --output OUTPUT — output directory location. Override settings.OUTPUT
--draft — do not ignore pages with date in the future
--port PORT, -p PORT — port to use (default: 8000)
--host HOST — host to bind to (default: localhost)

🔥 SHOW SUBCOMMAND 🔥

       usage: ssite show [-h] [-v] [--debug] [--theme THEME] [--draft]
       [--no-start]

              [--port PORT] [--host HOST]

positional arguments

project — project directory or .py configuration file (default: the current directory)

options

-h, --help — show this help message and exit
-v, --verbose — verbose output
--debug — debugging output
--theme THEME — theme directory location. Overrides settings.THEME
--content CONTENT — content directory location. Overrides settings.CONTENT
--archetypes ARCHETYPES — archetypes directory location. Override settings.ARCHETYPES
-o OUTPUT, --output OUTPUT — output directory location. Override settings.OUTPUT
--draft — do not ignore pages with date in the future
-a ARCHETYPE, --archetype ARCHETYPE — page archetype
-t TITLE, --title TITLE — page title
-n, --noedit — do not run an editor, only output the file name of the new post
--overwrite — if a post already exists, overwrite it instead of reusing it

🔥 EDIT SUBCOMMAND 🔥

       usage: ssite edit [-h] [-v] [--debug] [--theme THEME] [--content
       CONTENT]

              [--archetypes ARCHETYPES] [-o OUTPUT] [--draft] [-n] [project]
              [match ...]

positional arguments

project — project directory or .py configuration file (default: the current directory)
match — keywords used to look for the page to edit

options

-h, --help — show this help message and exit
-v, --verbose — verbose output
--debug — debugging output
--theme THEME — theme directory location. Overrides settings.THEME
--content CONTENT — content directory location. Overrides settings.CONTENT
--archetypes ARCHETYPES — archetypes directory location. Override settings.ARCHETYPES
-o OUTPUT, --output OUTPUT — output directory location. Override settings.OUTPUT
--draft — do not ignore pages with date in the future
-n, --noedit — do not run an editor, only output the file name of the new post

🔥 SITE SUBCOMMAND 🔥

       usage: ssite site [-h] [-v] [--debug] [--theme THEME] [--content
       CONTENT]

              [--archetypes ARCHETYPES] [-o OUTPUT] [--draft] [--cmd ...]

positional arguments

project — project directory or .py configuration file (default: the current directory)

options

-h, --help — show this help message and exit
-v, --verbose — verbose output
--debug — debugging output
--theme THEME — theme directory location. Overrides settings.THEME
--content CONTENT — content directory location. Overrides settings.CONTENT
--archetypes ARCHETYPES — archetypes directory location. Override settings.ARCHETYPES
-o OUTPUT, --output OUTPUT — output directory location. Override settings.OUTPUT
--draft — do not ignore pages with date in the future
--cmd ... — site-specific command (try 'help')

🔥 META SUBCOMMAND 🔥

       usage: ssite meta [-h] [-v] [--debug] file

positional arguments

file — edit the metadata of this file

options

-h, --help — show this help message and exit
-v, --verbose — verbose output
--debug — debugging output

🔥 SHELL SUBCOMMAND 🔥

       usage: ssite shell [-h] [-v] [--debug] [--theme THEME] [--content
       CONTENT]

              [--archetypes ARCHETYPES] [-o OUTPUT] [--draft]

positional arguments

project — project directory or .py configuration file (default: the current directory)

options

-h, --help — show this help message and exit
-v, --verbose — verbose output
--debug — debugging output
--theme THEME — theme directory location. Overrides settings.THEME
--content CONTENT — content directory location. Overrides settings.CONTENT
--archetypes ARCHETYPES — archetypes directory location. Override settings.ARCHETYPES
-o OUTPUT, --output OUTPUT — output directory location. Override settings.OUTPUT
--draft — do not ignore pages with date in the future

and that's where part 1 wraps bestie — do NOT go anywhere, there is literally more of this page and it's coming 💖✨

✨ positional arguments ✨

dir — the directory you want to show, bestie 💁♀️ (default: the current directory, aka wherever you're standing right now)

🎀 options 🎀

-h, --help — show this help message and exit. the classic. the icon. 👑
-v, --verbose — verbose output (it yaps more, affectionately)
--debug — debugging output 🐛
--theme THEME — theme directory location. Overrides settings.THEME, so yeah, this one wins, no cap
--draft — do not ignore pages with date in the future 🕰️✨
--no-start, -n — do not start a browser automatically, print the URL instead 🔗
--port PORT, -p PORT — port to use (default: randomly allocated 🎲)
--host HOST — host to bind to (default: localhost)

✨ NEW SUBCOMMAND ✨

okay so the new subcommand gives you this usage line, and we are copying it exactly because that's the whole vibe 💖

usage: ssite new [-h] [-v] [--debug] [--theme THEME] [--content CONTENT]
                 [--archetypes ARCHETYPES] [-o OUTPUT] [--draft] [-a ARCHETYPE]
                 [-t TITLE] [-n] [--overwrite]

that's every flag it takes, laid out in one gorgeous little block — -h, -v, --debug, --theme, --content, --archetypes, -o / OUTPUT, --draft, -a / ARCHETYPE, -t / TITLE, -n, and --overwrite 🦋

and that's the page, bestie, we ate and left absolutely no crumbs 💅 the footer on this one says the source/version is ssite 2.4 and it's dated September 2023 — that's SSITE(1) for you, periodt 🫶🌸

📦 where this page comes from

debian trixie: staticsite 2.5-1 · GPL-3.0-or-later
ubuntu noble: staticsite 2.4-1 · GPL-3.0-or-later
ubuntu resolute: staticsite 2.5-1 · GPL-3.0-or-later
ubuntu stonking: staticsite 2.5-1 · GPL-3.0-or-later
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-10-18: a language model's rewrite of the original, under its terms