AS1024
/
Kanboard-Prod
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Kanboard-Prod/doc/ru_RU/cli.markdown

8.1 KiB
Raw Blame History

Интерфейс командной строки

Канборд обеспечивает простой интерфейс командной строки, которым можно воспользоваться только из Unix терминала. Эта возможность доступна только с локальной машины.

Интерфейс командной строки полезен для выполнения команд вне процессов веб сервера.

Использование

  • Откройте терминал и перейдите в директорию Канборд (например: cd /var/www/kanboard)

  • Выполните команду ./kanboard

Kanboard version master



Usage:

  command [options] [arguments]



Options:

  -h, --help            Display this help message

  -q, --quiet           Do not output any message

  -V, --version         Display this application version

      --ansi            Force ANSI output

      --no-ansi         Disable ANSI output

  -n, --no-interaction  Do not ask any interactive question

  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug



Available commands:

  cronjob                            Execute daily cronjob

  help                               Displays help for a command

  list                               Lists commands

 export

  export:daily-project-column-stats  Daily project column stats CSV export (number of tasks per column and per day)

  export:subtasks                    Subtasks CSV export

  export:tasks                       Tasks CSV export

  export:transitions                 Task transitions CSV export

 locale

  locale:compare                     Compare application translations with the fr_FR locale

  locale:sync                        Synchronize all translations based on the fr_FR locale

 notification

  notification:overdue-tasks         Send notifications for overdue tasks

 plugin

  plugin:install                     Install a plugin from a remote Zip archive

  plugin:uninstall                   Remove a plugin

  plugin:upgrade                     Update all installed plugins

 projects

  projects:daily-stats               Calculate daily statistics for all projects

 trigger

  trigger:tasks                      Trigger scheduler event for all tasks

 user

  user:reset-2fa                     Remove two-factor authentication for a user

  user:reset-password                Change user password

Доступные команды

Экспорт задач в формате CSV

Применение:

./kanboard export:tasks <project_id> <start_date> <end_date>

Пример:

./kanboard export:tasks 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv

Данные CSV передаются в stdout.

Экспорт подзадач в формате CSV

Применение:

./kanboard export:subtasks <project_id> <start_date> <end_date>

Пример:

./kanboard export:subtasks 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv

Экспорт перемещения задач в формате CSV

Применение:

./kanboard export:transitions <project_id> <start_date> <end_date>

Пример:

./kanboard export:transitions 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv

Экспорт ежедневных сведений в формате CSV

Экспортированные данные будут выведены в стандартный вывод:

./kanboard export:daily-project-column-stats <project_id> <start_date> <end_date>

Пример:

./kanboard export:daily-project-column-stats 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv

Отправка уведомлений для просроченных задач

Email сообщения будут отправлены всем пользователям, у которых включено оповещение.

./kanboard notification:overdue-tasks

Необязательные параметры:

  • --show: Показывать отправку уведомлений

  • --group: Группировать все просроченные задачи для одного пользователя (со всех проектов) на один email

  • --manager: Посылать все просроченные задачи менеджеру (менеджерам) проекта в одном email сообщении

Вы можете просмотреть просроченные задачи с помощью параметра --show:

./kanboard notification:overdue-tasks --show
+-----+---------+------------+------------+--------------+----------+
| Id  | Title   | Due date   | Project Id | Project name | Assignee |
+-----+---------+------------+------------+--------------+----------+
| 201 | Test    | 2014-10-26 | 1          | Project #0   | admin    |
| 202 | My task | 2014-10-28 | 1          | Project #0   |          |
+-----+---------+------------+------------+--------------+----------+

Запуск ежедневной калькуляции статистики

Эта команда считает статистику для каждого проекта:

./kanboard projects:daily-stats

Run calculation for Project #0

Run calculation for Project #1

Run calculation for Project #10

Триггеры для задач

Эта команда посылает “событие для ежедневных фоновых заданий” для всех открытых задач в каждом проекте.

./kanboard trigger:tasks

Trigger task event: project_id=2, nb_tasks=1

Сброс пароля пользователя

./kanboard user:reset-password my_user

Будет запрошен пароль и подтверждение. Символы не отображаются на экране.

Удаление двухуровневой аутентификации для пользователя

./kanboard user:reset-2fa my_user

Установка плагина

./kanboard plugin:install https://github.com/kanboard/plugin-github-auth/releases/download/v1.0.1/GithubAuth-1.0.1.zip

Заметка: Установленные файлы будут иметь теже права, что и у текущего пользователя

Удаление плагина

./kanboard plugin:uninstall Budget

Обновление всех плагинов

./kanboard plugin:upgrade

* Updating plugin: Budget Planning

* Plugin up to date: Github Authentication

Русская документация Kanboard