@hesed/conni
v0.7.2
Published
CLI for Confluence API interaction
Readme
conni
CLI for Confluence API interaction
Install
sdkck plugins install @hesed/conniUsage
$ npm install -g @hesed/conni
$ conni COMMAND
running command...
$ conni (--version)
@hesed/conni/0.7.2 linux-x64 node-v24.14.1
$ conni --help [COMMAND]
USAGE
$ conni COMMAND
...Commands
conni conni auth addconni conni auth listconni conni auth profileconni conni auth testconni conni auth updateconni conni content attachment PAGEID FILEconni conni content attachment-download ATTACHMENTID [OUTPUTPATH]conni conni content comment PAGEID BODYconni conni content comment-delete IDconni conni content comment-update ID BODYconni conni content createconni conni content delete PAGEIDconni conni content get PAGEIDconni conni content search CQLconni conni content update PAGEIDconni conni space get SPACEKEYconni conni space list
conni conni auth add
Add Atlassian authentication
USAGE
$ conni conni auth add -t <value> -u <value> [--json] [-e <value>] [-p <value>]
FLAGS
-e, --email=<value> Account email
-p, --profile=<value> Profile name
-t, --token=<value> (required) API Token
-u, --url=<value> (required) Atlassian URL (start with https://)
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Add Atlassian authentication
EXAMPLES
$ conni conni auth add
$ conni conni auth add --profile workSee code: src/commands/conni/auth/add.ts
conni conni auth list
List authentication profiles
USAGE
$ conni conni auth list [--json]
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List authentication profiles
EXAMPLES
$ conni conni auth listSee code: src/commands/conni/auth/list.ts
conni conni auth profile
Set or show the default authentication profile
USAGE
$ conni conni auth profile [--json] [--default <value>]
FLAGS
--default=<value> Profile name to set as default
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Set or show the default authentication profile
EXAMPLES
$ conni conni auth profile
$ conni conni auth profile --default workSee code: src/commands/conni/auth/profile.ts
conni conni auth test
Test authentication and connection
USAGE
$ conni conni auth test [--json] [-p <value>]
FLAGS
-p, --profile=<value> Authentication profile name
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Test authentication and connection
EXAMPLES
$ conni conni auth test
$ conni conni auth test --profile workSee code: src/commands/conni/auth/test.ts
conni conni auth update
Update existing authentication profile
USAGE
$ conni conni auth update -t <value> -u <value> [--json] [-e <value>] [-p <value>]
FLAGS
-e, --email=<value> Account email
-p, --profile=<value> Profile name to update (default: "default")
-t, --token=<value> (required) API Token
-u, --url=<value> (required) Atlassian instance URL (start with https://)
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Update existing authentication profile
EXAMPLES
$ conni conni auth update
$ conni conni auth update --profile workSee code: src/commands/conni/auth/update.ts
conni conni content attachment PAGEID FILE
Add attachment to Confluence content
USAGE
$ conni conni content attachment PAGEID FILE [-p <value>] [--toon]
ARGUMENTS
PAGEID Page ID
FILE Path to the file to upload
FLAGS
-p, --profile=<value> Authentication profile name
--toon Format output as toon
DESCRIPTION
Add attachment to Confluence content
EXAMPLES
$ conni conni content attachment 123456 ./document.pdfSee code: src/commands/conni/content/attachment.ts
conni conni content attachment-download ATTACHMENTID [OUTPUTPATH]
Download attachment from Confluence content
USAGE
$ conni conni content attachment-download ATTACHMENTID [OUTPUTPATH] [-p <value>] [--toon]
ARGUMENTS
ATTACHMENTID Attachment ID
[OUTPUTPATH] Output file path
FLAGS
-p, --profile=<value> Authentication profile name
--toon Format output as toon
DESCRIPTION
Download attachment from Confluence content
EXAMPLES
$ conni conni content attachment-download att12345
$ conni conni content attachment-download att12345 ./document.pdfSee code: src/commands/conni/content/attachment-download.ts
conni conni content comment PAGEID BODY
Add comment to Confluence content
USAGE
$ conni conni content comment PAGEID BODY [-p <value>] [--toon]
ARGUMENTS
PAGEID Page ID
BODY Comment in Markdown format
FLAGS
-p, --profile=<value> Authentication profile name
--toon Format output as toon
DESCRIPTION
Add comment to Confluence content
EXAMPLES
$ conni conni content comment 123456 "
# Header
## Sub-header
- Item 1
- Item 2
```bash
ls -a
```"
$ conni conni content comment 123456 "$(cat content.md)"See code: src/commands/conni/content/comment.ts
conni conni content comment-delete ID
Delete comment from Confluence content
USAGE
$ conni conni content comment-delete ID [-p <value>] [--toon]
ARGUMENTS
ID Comment ID to delete
FLAGS
-p, --profile=<value> Authentication profile name
--toon Format output as toon
DESCRIPTION
Delete comment from Confluence content
EXAMPLES
$ conni conni content comment-delete 1544224770See code: src/commands/conni/content/comment-delete.ts
conni conni content comment-update ID BODY
Update a comment in Confluence content
USAGE
$ conni conni content comment-update ID BODY [-p <value>] [--toon]
ARGUMENTS
ID Comment ID to update
BODY Comment in Markdown format
FLAGS
-p, --profile=<value> Authentication profile name
--toon Format output as toon
DESCRIPTION
Update a comment in Confluence content
EXAMPLES
$ conni conni content comment-update 1544224770 "
# Header
## Sub-header
- Item 1
- Item 2
```bash
ls -a
```"
$ conni conni content comment-update 1544224770 "$(cat content.md)"See code: src/commands/conni/content/comment-update.ts
conni conni content create
Create a new Confluence page
USAGE
$ conni conni content create --fields <value>... [--attach <value>...] [--full-width] [-p <value>] [--toon]
FLAGS
-p, --profile=<value> Authentication profile name
--attach=<value>... Path to a file to upload and embed inline (can be used multiple times)
--fields=<value>... (required) Minimum fields required: spaceKey, title & body
--full-width Set page appearance to full-width
--toon Format output as toon
DESCRIPTION
Create a new Confluence page
EXAMPLES
$ conni conni content create --fields spaceKey="DEV" title="New title" body="New description" status="draft"
$ conni conni content create --fields spaceKey="DEV" title="New title" body='
# Header
## Sub-header
- Item 1
- Item 2
```bash
ls -a
```'
$ conni conni content create --fields spaceKey="DEV" title="Child page" body="Content" parentId="123456"
$ conni conni content create --fields spaceKey="DEV" title="Page with image" body="See the diagram:
" --attach ./diagram.png
$ conni conni content create --fields spaceKey="DEV" title="Page with files" body="Content" --attach ./image.png --attach ./report.pdf
$ conni conni content create --fields spaceKey="DEV" title="Storage page" [email protected] representation=storage --full-width
FLAG DESCRIPTIONS
--fields=<value>... Minimum fields required: spaceKey, title & body
Content fields in key=value format. Use @file to read value from a file (e.g. [email protected])See code: src/commands/conni/content/create.ts
conni conni content delete PAGEID
Delete a Confluence page
USAGE
$ conni conni content delete PAGEID [-p <value>] [--toon]
ARGUMENTS
PAGEID Page ID to delete
FLAGS
-p, --profile=<value> Authentication profile name
--toon Format output as toon
DESCRIPTION
Delete a Confluence page
EXAMPLES
$ conni conni content delete 1543634992See code: src/commands/conni/content/delete.ts
conni conni content get PAGEID
Get details of a Confluence content
USAGE
$ conni conni content get PAGEID [-p <value>] [--toon]
ARGUMENTS
PAGEID Page ID
FLAGS
-p, --profile=<value> Authentication profile name
--toon Format output as toon
DESCRIPTION
Get details of a Confluence content
EXAMPLES
$ conni conni content get 1544060948See code: src/commands/conni/content/get.ts
conni conni content search CQL
Search for Confluence contents using CQL
USAGE
$ conni conni content search CQL [--expand <value>] [--limit <value>] [-p <value>] [--toon]
ARGUMENTS
CQL CQL expression
FLAGS
-p, --profile=<value> Authentication profile name
--expand=<value> Properties of the content to expand
--limit=<value> Maximum number of contents per page
--toon Format output as toon
DESCRIPTION
Search for Confluence contents using CQL
EXAMPLES
$ conni conni content search 'space=DEV AND title ~ "Implement email OTP login" AND creator=currentUser()'
$ conni conni content search 'created > startOfMonth()' --limit=5 --expand=body,versionSee code: src/commands/conni/content/search.ts
conni conni content update PAGEID
Update an existing Confluence content
USAGE
$ conni conni content update PAGEID --fields <value>... [--full-width] [-p <value>] [--toon]
ARGUMENTS
PAGEID Page ID
FLAGS
-p, --profile=<value> Authentication profile name
--fields=<value>... (required) Content fields to update in key=value format. Use @file to read value from a file
(e.g. [email protected])
--full-width Set page appearance to full-width
--toon Format output as toon
DESCRIPTION
Update an existing Confluence content
EXAMPLES
$ conni conni content update 1076199489 --fields title='New summary' body='New description'
$ conni conni content update 1076199489 --fields body='
# Header
## Sub-header
- Item 1
- Item 2
```bash
ls -a
```'
$ conni conni content update 1076199489 --fields body="$(cat content.md)"
$ conni conni content update 1076199489 --fields [email protected] representation=storage --full-widthSee code: src/commands/conni/content/update.ts
conni conni space get SPACEKEY
Get details of a Confluence space
USAGE
$ conni conni space get SPACEKEY [-p <value>] [--toon]
ARGUMENTS
SPACEKEY Space key
FLAGS
-p, --profile=<value> Authentication profile name
--toon Format output as toon
DESCRIPTION
Get details of a Confluence space
EXAMPLES
$ conni conni space get DEVSee code: src/commands/conni/space/get.ts
conni conni space list
List all Confluence spaces
USAGE
$ conni conni space list [-p <value>] [--toon]
FLAGS
-p, --profile=<value> Authentication profile name
--toon Format output as toon
DESCRIPTION
List all Confluence spaces
EXAMPLES
$ conni conni space listSee code: src/commands/conni/space/list.ts
