Confluence CLI: командный интерфейс для управления контентом в Confluence

Проект confluence-cli представляет собой мощный интерфейс командной строки для работы с Atlassian Confluence, позволяющий управлять содержимым напрямую из терминала. Это значит, что ты можешь выполнять такие операции, как чтение, поиск и управление страницами и вложениями в Confluence без необходимости заходить в веб-интерфейс.

Функциональные возможности

Основные функции проекта включают:

• Чтение страниц в различных форматах: текстовом, HTML, формате хранения и Markdown.
• Поиск страниц с использованием продвинутого механизма поиска Confluence.
• Получение детальной информации о страницах.
• Список доступных пространств в Confluence.
• Создание, обновление и удаление страниц.
• Управление вложениями: загрузка, скачивание и удаление.
• Работа с метаданными контента и комментариями.
• Экспорт страниц и вложений в локальные папки.
• Поддержка нескольких профилей конфигурации для разных инстансов Confluence.
• Работа в режиме "только для чтения" для безопасного использования AI-агентами.

Установка и запуск

Чтобы установить confluence-cli, доступны несколько способов:

С помощью Homebrew (macOS/Linux)

brew install pchuri/tap/confluence-cli

Если используешь Homebrew версии 5.1.15 и выше, необходимо добавить tap в доверенные, чтобы убрать предупреждение:

brew trust pchuri/tap

С помощью npm

npm install -g confluence-cli

Либо запустить напрямую с помощью npx:

npx confluence-cli

Быстрый старт

После установки необходимо инициализировать конфигурацию с помощью команды:

confluence init

После этого ты можешь начать использовать команды для чтения, поиска, создания и обновления страниц:

confluence read 123456789

confluence search "my search term"

confluence create "My New Page" SPACEKEY --content "Hello World!"

Ограничения

Хотя confluence-cli обладает множеством функций, следует учитывать несколько ограничений:

• Не поддерживается перемещение страниц между пространствами.
• Контент, который не имеет "тела" (например, папки), нельзя обновлять.
• Работа в режиме "только для чтения" блокирует все операции записи.

Также стоит отметить, что для работы с некоторыми функциями могут потребоваться определенные права доступа в Confluence.

Заключение

Проект confluence-cli обеспечивает удобный способ взаимодействия с Confluence из командной строки, что может значительно ускорить рабочие процессы для пользователей, предпочитающих функционал терминала. Его возможности делает этот инструмент полезным как для программистов, так и для администраторов, эффективно управляющих содержимым в Confluence.