Confluence

simply atlassian confluence open

Open a Confluence page in the browser.

Flags

• --print — Print the URL without opening a browser.

Connection

• -e, --env-file <value> — Path to a .env file holding connection settings.
• --confluence-url <value> — Base URL of the Confluence instance. (env: CONFLUENCE_URL)
• --confluence-username <value> — Account email for Confluence Cloud basic auth. (env: CONFLUENCE_USERNAME)
• --confluence-api-token <value> — API token for Confluence Cloud basic auth. (env: CONFLUENCE_API_TOKEN)
• --confluence-personal-token <value> — Personal access token for Confluence Server/Data Center. (env: CONFLUENCE_PERSONAL_TOKEN)

Global

• --json — the raw API payload, for scripts and agents.

Builds the browser URL for a page id or page URL and opens it in the default browser. Use —print (or —url) to print the URL without launching a browser.

Examples

simply atlassian confluence open 123456

simply atlassian confluence open https://site.atlassian.net/wiki/spaces/DOCS/pages/123456/Title --print

simply atlassian confluence open 123456 --json

simply atlassian confluence page children

List the direct child pages of a Confluence page.

Flags

• --limit <value> — Maximum number of children to return. (default: 25)

Connection

• -e, --env-file <value> — Path to a .env file holding connection settings.
• --confluence-url <value> — Base URL of the Confluence instance. (env: CONFLUENCE_URL)
• --confluence-username <value> — Account email for Confluence Cloud basic auth. (env: CONFLUENCE_USERNAME)
• --confluence-api-token <value> — API token for Confluence Cloud basic auth. (env: CONFLUENCE_API_TOKEN)
• --confluence-personal-token <value> — Personal access token for Confluence Server/Data Center. (env: CONFLUENCE_PERSONAL_TOKEN)

Global

• --json — the raw API payload, for scripts and agents.

Lists pages one level below the given page. Use —json for the complete, unmodified API payload.

Examples

simply atlassian confluence page children 123456

simply atlassian confluence page children https://site.atlassian.net/wiki/spaces/DOCS/pages/123456/Title

simply atlassian confluence page children 123456 --limit 50 --json

simply atlassian confluence page comment add

Add a comment to a Confluence page.

Flags

• --dry-run — Print the request that would be sent and exit without sending it.
• --text <value> — Comment as plain text; becomes paragraphs, markup escaped.
• --body <value> — Comment as raw storage-format XHTML.
• --body-file <value> — Path to a file holding storage-format XHTML.
• --markdown <value> — Body as Markdown; converted to storage format.
• --markdown-file <value> — Path to a Markdown file; converted to storage format.

Connection

• -e, --env-file <value> — Path to a .env file holding connection settings.
• --confluence-url <value> — Base URL of the Confluence instance. (env: CONFLUENCE_URL)
• --confluence-username <value> — Account email for Confluence Cloud basic auth. (env: CONFLUENCE_USERNAME)
• --confluence-api-token <value> — API token for Confluence Cloud basic auth. (env: CONFLUENCE_API_TOKEN)
• --confluence-personal-token <value> — Personal access token for Confluence Server/Data Center. (env: CONFLUENCE_PERSONAL_TOKEN)

Global

• --json — the raw API payload, for scripts and agents.

A Confluence comment is content in its own right rather than a field on the page, so it takes the same body flags as a page: —text for plain prose, or —body/—body-file for storage-format XHTML. Markdown is not supported yet.

Examples

simply atlassian confluence page comment add 123456 --text "Reviewed, looks right."

simply atlassian confluence page comment add 123456 --body "<p>See <strong>section 2</strong>.</p>"

simply atlassian confluence page comment add 123456 --text "wip" --dry-run

simply atlassian confluence page comment list

List a Confluence page’s comments.

Flags

• --limit <value> — Maximum number of comments to return. (default: 25)

Connection

• -e, --env-file <value> — Path to a .env file holding connection settings.
• --confluence-url <value> — Base URL of the Confluence instance. (env: CONFLUENCE_URL)
• --confluence-username <value> — Account email for Confluence Cloud basic auth. (env: CONFLUENCE_USERNAME)
• --confluence-api-token <value> — API token for Confluence Cloud basic auth. (env: CONFLUENCE_API_TOKEN)
• --confluence-personal-token <value> — Personal access token for Confluence Server/Data Center. (env: CONFLUENCE_PERSONAL_TOKEN)

Global

• --json — the raw API payload, for scripts and agents.

One line per comment. Bodies are stored as XHTML, so the preview column is flattened text; use —json for the unmodified payload. The ID column is what any later reply or removal needs and is not otherwise discoverable.

Examples

simply atlassian confluence page comment list 123456

simply atlassian confluence page comment list 123456 --limit 5 --json

simply atlassian confluence page create

Create a Confluence page.

Flags

• --dry-run — Print the request that would be sent and exit without sending it.
• --space <value> — Space key the page belongs to. (required)
• --title <value> — Page title. (required)
• --parent <value> — Parent page id or URL, making this a child of it.
• --text <value> — Body as plain text; becomes paragraphs, markup escaped.
• --body <value> — Body as raw storage-format XHTML.
• --body-file <value> — Path to a file holding storage-format XHTML.
• --markdown <value> — Body as Markdown; converted to storage format.
• --markdown-file <value> — Path to a Markdown file; converted to storage format.

Connection

• -e, --env-file <value> — Path to a .env file holding connection settings.
• --confluence-url <value> — Base URL of the Confluence instance. (env: CONFLUENCE_URL)
• --confluence-username <value> — Account email for Confluence Cloud basic auth. (env: CONFLUENCE_USERNAME)
• --confluence-api-token <value> — API token for Confluence Cloud basic auth. (env: CONFLUENCE_API_TOKEN)
• --confluence-personal-token <value> — Personal access token for Confluence Server/Data Center. (env: CONFLUENCE_PERSONAL_TOKEN)

Global

• --json — the raw API payload, for scripts and agents.

The body is Confluence storage format — XHTML plus Atlassian macro tags — supplied with —body or —body-file. Markdown input is not supported yet; —text is the shortcut for plain prose, which becomes paragraphs with its markup characters escaped. Use —parent to place the page under another rather than at the space root, and —dry-run to see the exact request without sending it.

Examples

simply atlassian confluence page create --space DOCS --title "Release notes" --text "Shipped today."

simply atlassian confluence page create --space DOCS --title "Design" --body-file ./page.xml --parent 123456

simply atlassian confluence page create --space DOCS --title "Draft" --text "wip" --dry-run

simply atlassian confluence page delete

Move a Confluence page to the trash, or destroy it.

Flags

• --dry-run — Print the request that would be sent and exit without sending it.
• --confirm — Required to proceed with an irreversible change.
• --purge — Destroy the page permanently instead of trashing it. Requires —confirm.

Connection

• -e, --env-file <value> — Path to a .env file holding connection settings.
• --confluence-url <value> — Base URL of the Confluence instance. (env: CONFLUENCE_URL)
• --confluence-username <value> — Account email for Confluence Cloud basic auth. (env: CONFLUENCE_USERNAME)
• --confluence-api-token <value> — API token for Confluence Cloud basic auth. (env: CONFLUENCE_API_TOKEN)
• --confluence-personal-token <value> — Personal access token for Confluence Server/Data Center. (env: CONFLUENCE_PERSONAL_TOKEN)

Global

• --json — the raw API payload, for scripts and agents.

By default this trashes the page, which is reversible — it can be restored from the space trash — so no —confirm is required. —purge destroys it permanently and does require —confirm, because nothing brings it back. A page that is already trashed is purged directly; one that is not is trashed and then purged, so —purge always means “gone”.

Examples

simply atlassian confluence page delete 123456

simply atlassian confluence page delete 123456 --purge --confirm

simply atlassian confluence page delete 123456 --purge --dry-run

simply atlassian confluence page get

Show a single Confluence page.

Flags

• --body-format <value> — How to render the page body. (default: markdown; one of: markdown, storage, none)
• --expand <value> — Comma-separated Confluence expansions, replacing the default set.

Connection

• -e, --env-file <value> — Path to a .env file holding connection settings.
• --confluence-url <value> — Base URL of the Confluence instance. (env: CONFLUENCE_URL)
• --confluence-username <value> — Account email for Confluence Cloud basic auth. (env: CONFLUENCE_USERNAME)
• --confluence-api-token <value> — API token for Confluence Cloud basic auth. (env: CONFLUENCE_API_TOKEN)
• --confluence-personal-token <value> — Personal access token for Confluence Server/Data Center. (env: CONFLUENCE_PERSONAL_TOKEN)

Global

• --json — the raw API payload, for scripts and agents.

Prints page metadata followed by its body. The body is converted to Markdown by default; —body-format storage prints the stored XHTML verbatim, and none omits it entirely (and does not request it, which matters when listing pages whose content will not be read). Use —json for the complete, unmodified API payload.

Examples

simply atlassian confluence page get 123456

simply atlassian confluence page get https://site.atlassian.net/wiki/spaces/DOCS/pages/123456/Title

simply atlassian confluence page get 123456 --body-format none

simply atlassian confluence page get 123456 --json

simply atlassian confluence page label add

Add labels to a page.

Flags

• --dry-run — Print the request that would be sent and exit without sending it.
• --label <value> — Label to add. Repeatable. (required)
• --prefix <value> — Label namespace. (default: global)

Connection

• -e, --env-file <value> — Path to a .env file holding connection settings.
• --confluence-url <value> — Base URL of the Confluence instance. (env: CONFLUENCE_URL)
• --confluence-username <value> — Account email for Confluence Cloud basic auth. (env: CONFLUENCE_USERNAME)
• --confluence-api-token <value> — API token for Confluence Cloud basic auth. (env: CONFLUENCE_API_TOKEN)
• --confluence-personal-token <value> — Personal access token for Confluence Server/Data Center. (env: CONFLUENCE_PERSONAL_TOKEN)

Global

• --json — the raw API payload, for scripts and agents.

Labels are additive and idempotent: adding one the page already has is not an error, and this reports what the page carries afterwards rather than implying everything was new. No —confirm, because adding a label loses nothing.

Examples

simply atlassian confluence page label add 123456 --label runbook

simply atlassian confluence page label add 123456 --label runbook --label on-call

simply atlassian confluence page label add 123456 --label draft --dry-run

simply atlassian confluence page label list

List a page’s labels.

Flags

• --limit <value> — Maximum number of labels to show. (default: 25)

Connection

• -e, --env-file <value> — Path to a .env file holding connection settings.
• --confluence-url <value> — Base URL of the Confluence instance. (env: CONFLUENCE_URL)
• --confluence-username <value> — Account email for Confluence Cloud basic auth. (env: CONFLUENCE_USERNAME)
• --confluence-api-token <value> — API token for Confluence Cloud basic auth. (env: CONFLUENCE_API_TOKEN)
• --confluence-personal-token <value> — Personal access token for Confluence Server/Data Center. (env: CONFLUENCE_PERSONAL_TOKEN)

Global

• --json — the raw API payload, for scripts and agents.

The PREFIX column is shown because Confluence namespaces labels — global, my, team — and the prefix is part of the identity, so two different labels can share a name.

Examples

simply atlassian confluence page label list 123456

simply atlassian confluence page label list 123456 --json

simply atlassian confluence page search

Search Confluence content with CQL.

Flags

• --cql <value> — CQL query to run. (required)
• --limit <value> — Maximum number of results to return across all pages. (default: 25)

Connection

• -e, --env-file <value> — Path to a .env file holding connection settings.
• --confluence-url <value> — Base URL of the Confluence instance. (env: CONFLUENCE_URL)
• --confluence-username <value> — Account email for Confluence Cloud basic auth. (env: CONFLUENCE_USERNAME)
• --confluence-api-token <value> — API token for Confluence Cloud basic auth. (env: CONFLUENCE_API_TOKEN)
• --confluence-personal-token <value> — Personal access token for Confluence Server/Data Center. (env: CONFLUENCE_PERSONAL_TOKEN)

Global

• --json — the raw API payload, for scripts and agents.

Runs a CQL query and follows result pages until the limit is reached or the instance has no more matches. Use —json for the complete, unmodified API payload of every result.

Examples

simply atlassian confluence page search --cql "type = page AND space = DOCS"

simply atlassian confluence page search --cql 'text ~ "release notes"' --limit 10

simply atlassian confluence page search --cql "type = page order by lastmodified desc" --limit 5 --json

simply atlassian confluence page update

Replace a Confluence page’s body or title.

Flags

• --dry-run — Print the request that would be sent and exit without sending it.
• --title <value> — New title. Defaults to the page’s current title.
• --text <value> — Body as plain text; becomes paragraphs, markup escaped.
• --body <value> — Body as raw storage-format XHTML.
• --body-file <value> — Path to a file holding storage-format XHTML.
• --markdown <value> — Body as Markdown; converted to storage format.
• --markdown-file <value> — Path to a Markdown file; converted to storage format.
• --append — Add the new body to the end of the page instead of replacing it.

Connection

• -e, --env-file <value> — Path to a .env file holding connection settings.
• --confluence-url <value> — Base URL of the Confluence instance. (env: CONFLUENCE_URL)
• --confluence-username <value> — Account email for Confluence Cloud basic auth. (env: CONFLUENCE_USERNAME)
• --confluence-api-token <value> — API token for Confluence Cloud basic auth. (env: CONFLUENCE_API_TOKEN)
• --confluence-personal-token <value> — Personal access token for Confluence Server/Data Center. (env: CONFLUENCE_PERSONAL_TOKEN)

Global

• --json — the raw API payload, for scripts and agents.

The version number is handled for you: the page is read, its version incremented, and the result sent. There is no —version flag, because Confluence refuses a stale version with a conflict rather than overwriting — so if someone edits the page while this runs, the command fails and says so instead of discarding their work. Re-run it to pick up their change. This REPLACES the body by default; use —append to add to the end instead.

Examples

simply atlassian confluence page update 123456 --text "Updated status."

simply atlassian confluence page update 123456 --body-file ./page.xml

simply atlassian confluence page update 123456 --title "Renamed" --dry-run