https://github.com/Sanofi-IADC/konflu-cli

Martial Arts for Confluence automation
https://github.com/Sanofi-IADC/konflu-cli

command-line confluence

Last synced: about 2 months ago
JSON representation

Martial Arts for Confluence automation

• Host: GitHub
• URL: https://github.com/Sanofi-IADC/konflu-cli
• Owner: Sanofi-IADC
• License: mit
• Created: 2021-01-01T12:13:32.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2023-12-15T08:17:50.000Z (11 months ago)
• Last Synced: 2023-12-15T09:28:45.511Z (11 months ago)
• Topics: command-line, confluence
• Language: TypeScript
• Homepage:
• Size: 171 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• top-pharma-fr - **Sanofi-IADC/konflu-cli** - line`, `confluence`<br><img src='https://github.com/HubTou/topgh/blob/main/icons/gstars.png'> 4 <img src='https://github.com/HubTou/topgh/blob/main/icons/forks.png'> 1 <img src='https://github.com/HubTou/topgh/blob/main/icons/code.png'> TypeScript <img src='https://github.com/HubTou/topgh/blob/main/icons/license.png'> MIT License <img src='https://github.com/HubTou/topgh/blob/main/icons/last.png'> 2023-12-15 08:17:50 | (Ranked by starred repositories)

README

        
[
](<(https://sanofi-iadc.github.io/konflu-cli/)>)


# Introduction

[![semantic-release][semantic-release-shield]][semantic-release-url]

[![MIT License][license-shield]][license-url]

> Martial Arts for Confluence

Konflu-cli is an open source command line interface to automatize routines which are not well supported by Confluence administration interface. It gives you the best of the martial arts to be more productive while dealing with large Confluence instances.

While this is just the begining we encourage you to contribute to increase the number of functions available.

# Features

- [x] Parameters retrieved by interactive questions (via [Inquirer.js](https://github.com/SBoudrias/Inquirer.js))

- [ ] Parameters via command line options

- [x] Login to Confluence API as defaults

- [x] Copy Page Hierarchy

- [ ] Copy Permissions

- [x] Add Label

- [x] Delete Pages

- [x] Delete Children

- [ ] Plugin system

# Install

```sh

npm install -g konflu-cli

```

Or just clone the repo and run the scripts in the package.json

# Usage

TODO

# Tech stack

## to make the command line great again

- [Inquirer.js](https://github.com/SBoudrias/Inquirer.js) - A collection of common interactive command line user interfaces.

- [Chalk](https://github.com/chalk/chalk) - Terminal string styling done right.

- [clui](https://github.com/nathanpeck/clui) - Command Line UI toolkit for Node.js.

- [configstore](https://github.com/yeoman/configstore) - Easily load and persist config without having to think about where and how.

- [figlet.js](https://github.com/patorjk/figlet.js) - A FIG Driver written in JavaScript which aims to fully implement the FIGfont spec.

- [clui](https://github.com/nathanpeck/clui) - Command Line UI toolkit for Node.js.

- Confluence REST API via [Axios](https://github.com/axios/axios)

- [validator](https://github.com/validatorjs/validator.js) - A library of string validators and sanitizers.

# Sponsorship

We’re not looking for sponsorship, please check out the pages of our favourite open source projects which make up our standard tech stack.

# Maintainers

- Jose Gascon

[semantic-release-shield]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg

[semantic-release-url]: https://github.com/Sanofi-IADC/konflu-cli/releases

[license-shield]: https://img.shields.io/badge/License-MIT-green.svg

[license-url]: https://github.com/Sanofi-IADC/konflu-cli/blob/master/LICENSE