NAME

dapper - A publishing tool for static websites.

SYNOPSIS

dapper [options] <command>

# Initialize the current directory with a fresh skeleton of a site
$ dapper init

# ...or with a complete starter blog
$ dapper init --template blog

# ...or a portfolio, business or docs site, or a theme from git
$ dapper init --template business
$ dapper init --template https://github.com/someone/dapper-theme.git

# List the starter templates
$ dapper templates

# Build the site
$ dapper build

# ...including drafts and pages dated in the future
$ dapper build --drafts

# Build the site, then serve it locally at http://localhost:8000,
# rebuilding whenever a file changes
$ dapper serve

# Rebuild the site whenever a file (source, layout, config) changes
$ dapper watch

# Check the site for problems (add --json for a machine-readable report)
$ dapper check

# Build, check and publish the site (to S3, GitHub Pages, or a command)
$ dapper deploy
$ dapper deploy --dry-run
$ dapper deploy s3    # with several targets, name one

# Let AI assistants work on the site over MCP
$ dapper -C /path/to/site mcp

# Write or update AGENTS.md, which explains the project to AI coding agents
$ dapper agents

# Bring in the pages of a WordPress, Jekyll, Hugo or Medium site
$ dapper import wordpress export.xml
$ dapper import jekyll ../old-site --dry-run

# Get help on usage and switches
$ dapper -h

# Print the version
$ dapper -v

DESCRIPTION

Dapper transforms simple text files into static websites. Source files (Markdown with YAML front matter) are combined with layout templates and written to an output directory.

See App::Dapper or the README at https://github.com/markdbenson/dapper for the full documentation: the project file, source files, layouts, variables, filters and deployment.

OPTIONS

-s, --source=source directory

Specify the directory containing source files to process. If this command line option is not present, it defaults to the source setting in the config file, or "_source".

-o, --output=output directory

Specify the directory to place the output files in. If this command line option is not present, it defaults to the output setting in the config file, or "_output".

-l, --layout=layout directory

Specify the directory containing layout files. If this command line option is not present, it defaults to the layout setting in the config file, or "_layout".

-c, --config=config file

Specify the config file name to use. If this command line option is not present, it defaults to "_config.yml".

-p, --port=port

Specify the port to use for the serve command. This option is only used for the serve command. If this command line option is not present, it defaults to "8000".

-q, --quiet

Only print errors.

-C, --directory=directory

Run in this directory instead of the current one.

-t, --template=name

For the init command: the starter to create, a built-in template (see dapper templates), a directory, or a git URL.

--dry-run, --force, --no-build

For the deploy command: show what would happen without publishing; deploy even if dapper check finds errors; deploy the output directory without building it first. --dry-run also works for the import command.

--to=directory

For the import command: the directory in the source directory that imported posts go in (default: blog).

--drafts

For the build, watch and check commands: include drafts and pages dated in the future, which are otherwise held back. dapper serve always includes them; dapper deploy never does.

--json

For the check command: print the report as JSON.

-h, --help

Get help on available commands and options.

-v, --version

Print the version and exit.

AUTHOR

Mark Benson, <mark at jayber.org>

BUGS

Please report any bugs or feature requests at https://github.com/markdbenson/dapper/issues.

LICENSE AND COPYRIGHT

The MIT License (MIT)

Copyright (c) 2002-2026 Mark Benson

See App::Dapper for the full license text.