https://github.com/alsiola/readme2confluence
https://github.com/alsiola/readme2confluence
Last synced: 22 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/alsiola/readme2confluence
- Owner: alsiola
- Created: 2018-10-20T21:31:20.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-02-12T14:17:01.000Z (over 4 years ago)
- Last Synced: 2025-02-02T21:59:37.757Z (over 1 year ago)
- Language: JavaScript
- Size: 21.5 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# readme2confluence
CLI to publish package READMEs to Confluence Cloud
## Installation
Install globally with either:
`npm install -g readme2confluence`
or
`yarn global add readme2confluence`
## Usage
THe following CLI arguments can be used. Only username, apikey, space and company are required.
```
-V, --version output the version number
-u --username [username] Username
-k --apikey [apikey] API Key
-s --space [space] Confluent Space
-c --company [company] Company name (url slug)
-a --ancestor [ancestor] Parent page ID
-h, --help output usage information
```
Alternatively, the following environment variables will be used if CLI arguments are not provided:
```
RTC_USERNAME,
RTC_APIKEY,
RTC_SPACE,
RTC_COMPANY,
RTC_ANCESTOR
```
Typical usage is:
```
readme2confluence \
--username test@example.com \
--apikey secret \
--space GF \
--company companyname \
--ancestor 12345678
```