---
name: "ssite"
section: "1"
platform: "linux"
package: "staticsite"
version: "2.5-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/ssite"
---

# ssite(1)

ssite

## NAME

ssite - ssite

## DESCRIPTION

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

-

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

Static site generator.

### positional arguments:

- {check,dump,dump\_meta,build,serve,show,new,edit,site,meta,shell}

  sub-command help

-

  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: ssite check \[-h\] \[-v\] \[--debug\] \[--theme THEME\] \[--content CONTENT\]

-

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

## PROJECT

### 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

## DIR

### positional arguments:

- dir

  directory to show (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

- **--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

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

-

  \[--archetypes ARCHETYPES\] \[-o OUTPUT\] \[--draft\] \[-a ARCHETYPE\] \[-t TITLE\] \[-n\] \[--overwrite\]