Docs & Canvases

Manage structured project knowledge from the terminal. Use the built-in help for the current arguments and options for any command.

Quick start

pf canvases list --project <project-id>
pf spaces list --project <project-id>
pf docs list --space <space-id>
pf docs versions <doc-id>

Command families

Canvases

pf canvases

Create and maintain canvases in a project. The cv alias is also available.

Actions: list, create, view, edit, archive, delete

Spaces

pf spaces

List the spaces that organize docs, optionally filtered by project.

Actions: list

Docs

pf docs

Manage doc metadata, Plate JSON content, and version history.

Actions: list, view, create, edit, set-content, versions, restore-version, archive, delete

Doc content files

Doc content is stored as a Plate JSON document. Pass a file path to--content-fileor use - to read JSON from stdin.

pf docs create --space <space-id> --title "Launch notes" --content-file page.json
pf docs set-content <doc-id> --content-file page.json --change-note "Update launch plan"

Command help

pf canvases --help
pf docs --help
pf docs create --help