Overview

Shell for Confluence is a free Confluence Cloud app that lets you manage spaces and pages from a bash-like console. It maps your site to a filesystem: / is the site root, followed by spaces and their pages.

Navigate content

Use ls, ls -l, ls --format csv, pwd, and cd to navigate spaces and pages. Use cat, open, and find (-name, -maxdepth, -mtime, -prune) to view or find content. Use tree for an ASCII page tree (-L / --maxdepth; default depth 3). Tab completion and command history make deep page trees easier to navigate.

Filter results with grep, head, tail, wc, or sort. To search page content, use find … -exec grep PATTERN. To create shortcuts in your browser, use alias and unalias. For help, enter help or help <command>.

Organize pages like files

Use mv, cp, touch, and rm (or del) to move, copy, create, and delete pages. You can pass multiple page names, use * / ? on source paths, or pipe paths from find or grep (at most 100 sources, same space). Use attach for page attachments (list, trash, rename). Pipe long output through less. Use checkout or restore to work with page versions.

Use cases

See Use cases for recipes that combine these commands.

Choose a theme

Use theme to switch console themes and adjust font, size, and height. Settings persist in this browser.

The top level is /. It contains spaces, and each space contains its pages. Use cd to move through this structure.