Complete CLI Reference¶

This is a full reference of the cfr command, with the same information as you get from using --help. It is generated from source code and thus always up to date. See Using Confluencer for a more detailed description.

Available Commands

cfr
- help
- pretty
- rm
  - tree
- stats
  - tree
  - usage
- tidy

cfr ¶

‘confluencer’ command line tool.

cfr [OPTIONS] COMMAND [ARGS]...

Options

--version¶: Show the version and exit.

--license¶: Show the license and exit.

-q, --quiet¶: Be quiet (show only errors).

-v, --verbose¶: Create extra verbose output.

-c, --config <config_paths>¶: Load given configuration file(s).

help ¶

Print some information on the system environment.

cfr help [OPTIONS]

Options

-c, --config-dump¶: Dump the merged configuration to stdout.

pretty ¶

Pretty-print page content markup.

cfr pretty [OPTIONS] ‹page-url›…

Options

-R, --recursive¶: Handle all descendants.

-J, --json¶: Print raw API response (JSON).

-f, --format <markup>¶

Markup format.

Options:	view\|editor\|storage\|export\|anon

Arguments

‹page-url›…¶: Optional argument(s)

rm ¶

Remove contents.

cfr rm [OPTIONS] COMMAND [ARGS]...

tree ¶

Remove page(s) including their descendants.

cfr rm tree [OPTIONS] ‹page-url›…

Arguments

‹page-url›…¶: Optional argument(s)

stats ¶

Create status reports (or data exports).

cfr stats [OPTIONS] COMMAND [ARGS]...

Options

-f, --format <serializer>¶

Output format (defaults to extension of OUTFILE).

Options:	dict\|json\|html\|yaml\|csv\|tsv\|ods\|xls

-s, --space <space>¶

-e, --entity <entity>¶

Entity to handle / search for.

Options:	macro

-o, --outfile <outfile>¶

tree ¶

Export metadata of a page tree.

cfr stats tree [OPTIONS] ROOTPAGE

Arguments

ROOTPAGE¶: Required argument

usage ¶

Create report on usage of different entities (macros, labels, …).

cfr stats usage [OPTIONS] QUERY

Options

--top <top>¶: Show top ‹N› ranked entities.

Arguments

QUERY¶: Required argument

tidy ¶

Tidy pages after cut&paste migration from other wikis.

cfr tidy [OPTIONS] ‹page-url›…

Options

--diff¶: Show differences after tidying.

-n, --no-save, --dry-run¶: Only show differences after tidying, don’t apply them (use twice for no diff).

-R, --recursive¶: Handle all descendants.

Arguments

‹page-url›…¶: Optional argument(s)