wiki¶

vb wiki SUBCOMMAND [WikiName] [OPTIONS]

Description¶

Run various subcommands to work with wiki entries or tech notes.

The Sandbox wiki pseudo-page is a special case. Its name is checked case-insensitively and either create or commit may be used to update its contents.

DATETIME

Subcommands¶

vb wiki export¶

vb wiki export [OPTIONS] {WikiName|--technote} [FILE]

Description¶

Sends the latest version of either a wiki page or of a tech note to the given file or standard output. A filename of - writes the output to standard output. The directory parts of the output filename are created if needed. If WikiName is provided, the named wiki page will be output.

Options¶

-t, --technote DATETIME|TECHNOTE-ID|TAG¶: Specifies that a technote, rather than a wiki page, will be exported. If DATETIME is used, the most recently modified tech note with that DATETIME will output. If TAG is used, the most recently modified tech note with that TAG will be output.

-h, --html¶: The body (only) is rendered in HTML form, without any page header/foot or HTML/BODY tag wrappers.

-H, --HTML¶: Works like -h|-html but wraps the output in <html><body>…</body></html>.

-p, --pre¶: If -h | -H is used and the page or technote has the text/plain mimetype, its HTML-escaped output will be wrapped in <pre>…</pre>.

vb wiki create (commit)¶

vb wiki create|commit {WikiName|TECHNOTE-COMMENT} [FILE] [OPTIONS]

Description¶

Create a new or commit changes to an existing wiki page or technote from FILE or from standard input. WikiName is the name of the wiki entry. TECHNOTE-COMMENT is the timeline comment of the technote.

Options¶

-M, --mimetype TEXT-FORMAT¶: The mime type of the update. Defaults to the type used by the previous version of the page, or text/x-fossil-wiki. Valid values are: text/x-fossil-wiki, text/x-markdown and text/plain. fossil, markdown or plain can be specified as synonyms of these values.

-t, --technote DATETIME¶: Specifies the timestamp of the technote to be created or updated. The timestamp specifies when this technote appears in the timeline and is its permanent handle although it may not be unique. When updating a technote the most recently modified tech note with the specified timestamp will be updated.

-t, --technote TECHNOTE-ID¶: Specifies the technote to be updated by its technote id, which is its UUID.

--technote-tags TAGS¶: The set of tags for a technote.

--technote-bgcolor COLOR¶: The color used for the technote on the timeline.

vb wiki list (ls)¶

vb wiki list|ls [OPTIONS]

Description¶

Lists all wiki entries, one per line, ordered case-insensitively by name. Wiki pages associated with check-ins and branches are NOT shown, unless -a is given.

Options¶

--all¶: Include deleted pages in output. By default deleted pages are elided.

-t, --technote¶: Technotes will be listed instead of pages. The technotes will be in order of timestamp with the most recent first.

-a, --show-associated¶: Show wiki pages associated with check-ins and branches.

-s, --show-technote-ids¶: The id of the tech note will be listed along side the timestamp. The tech note id will be the first word on each line. This option only applies if the --technote option is also specified.

Examples¶

Create a wiki

$ vb sys echo "# This is a test markdown file" > wiki1.md
$ vb wiki create W1 wiki1.md -M text/x-markdown
Created new wiki page W1.

Create a technote

$ vb wiki create "Test of technote coment" -t 2026-02-03 wiki1.md
Created new tech note 2026-02-03 00:00:00.

List all wikis and technote

$ vb wiki ls
W1
$ vb wiki ls -t
2026-02-03 00:00:00

Export wiki to html

$ vb wiki export W1 -H
<html><body><div class="markdown">

<h1>This is a test markdown file</h1>
</div>
</body></html>