You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -264,7 +264,7 @@ The stats file (`stats.json`) follows the same resolution and lives alongside `c
264
264
265
265
**Custom domains on Confluence Cloud:**
266
266
267
-
If your Confluence Cloud instance uses a custom domain (e.g., `wiki.example.org` instead of `*.atlassian.net`), the CLI may misidentify it as a Server/Data Center instance and produce broken link formats. Set `CONFLUENCE_FORCE_CLOUD=true` to override the automatic detection:
267
+
If your Confluence Cloud instance uses a custom domain (e.g., `wiki.example.org` instead of `*.atlassian.net`), the CLI may identify it as a Server/Data Center instance and use standard links instead of Cloud smart links. Set `CONFLUENCE_FORCE_CLOUD=true` to override the automatic detection:
268
268
269
269
```bash
270
270
export CONFLUENCE_FORCE_CLOUD=true
@@ -283,9 +283,9 @@ Or add `"forceCloud": true` to your profile in the config file (see [Config file
283
283
}
284
284
```
285
285
286
-
**Link rendering on Cloud (`linkStyle`):**
286
+
**Link rendering (`linkStyle`):**
287
287
288
-
Some Cloud instances — particularly custom-domain Cloud setups — fail to render smart links (`<a data-card-appearance="inline">`) and show "Cannot handle: DefaultLink" errors instead. If you hit this, set `linkStyle` to `plain` to emit simple `<a href>` tags, which render reliably everywhere:
288
+
External links use Cloud smart links (`<a data-card-appearance="inline">`) on Cloud and standard `<a href>` tags on Server/Data Center and local conversions. Some Cloud instances — particularly custom-domain Cloud setups — fail to render smart links and show "Cannot handle: DefaultLink" errors instead. If you hit this, set `linkStyle` to `plain`:
289
289
290
290
```bash
291
291
export CONFLUENCE_LINK_STYLE=plain
@@ -305,7 +305,7 @@ Or per-profile:
305
305
}
306
306
```
307
307
308
-
Valid values: `smart` (Cloud smart links), `plain` (simple`<a href>`), `wiki` (Server/DC`ac:link`). When unset, the CLI picks `smart` for Cloud and `wiki` for Server/DC — existing behavior is unchanged.
308
+
Valid values: `smart` (Cloud smart links), `plain` (standard`<a href>`), and `wiki` (legacy`ac:link` + `ri:url` output for explicit backward compatibility). When unset, the CLI picks `smart` for Cloud and `plain` for Server/Data Center and local conversions. New configurations should not use `wiki` for external links.
|`CONFLUENCE_PROFILE`| Named profile to use (optional) |`staging`|
31
31
|`CONFLUENCE_READ_ONLY`| Block all write operations when `true`|`true`|
32
32
|`CONFLUENCE_FORCE_CLOUD`| Force Cloud link format for custom domains |`true`|
33
-
|`CONFLUENCE_LINK_STYLE`| Override link rendering: `smart`, `plain`, or `wiki`|`plain`|
33
+
|`CONFLUENCE_LINK_STYLE`| Override link rendering: `smart`, `plain`, or legacy `wiki`|`plain`|
34
34
35
35
**Global `--profile` flag (use a named profile for any command):**
36
36
@@ -55,7 +55,7 @@ confluence init \
55
55
56
56
**Cloud vs Server/DC:**
57
57
- Atlassian Cloud (`*.atlassian.net`): use `--api-path "/wiki/rest/api"`, auth type `basic` with email + API token
58
-
- Atlassian Cloud (custom domain): if your Cloud instance uses a custom domain (e.g., `wiki.example.org`), set `CONFLUENCE_FORCE_CLOUD=true` or add `"forceCloud": true` to your profile in `~/.confluence-cli/config.json`. Without this, links will render incorrectly.
58
+
- Atlassian Cloud (custom domain): if your Cloud instance uses a custom domain (e.g., `wiki.example.org`), set `CONFLUENCE_FORCE_CLOUD=true` or add `"forceCloud": true` to your profile in `~/.confluence-cli/config.json` to enable Cloud smart-link rendering.
59
59
- Atlassian Cloud (scoped token): use `--domain "api.atlassian.com"`, `--api-path "/ex/confluence/<your-cloud-id>/wiki/rest/api"`, auth type `basic` with email + scoped token. Get your Cloud ID from `https://<your-site>.atlassian.net/_edge/tenant_info`. Recommended for agents (least privilege).
60
60
- Self-hosted / Data Center: use `--api-path "/rest/api"`, auth type `bearer` with a personal access token (no email needed)
0 commit comments