コマンドラインインターフェースについて¶
Kanboard にはUnixターミナルから利用可能な、シンプルなコマンドラインインターフェースがあります。このツールはローカルPCからのみ使用可能です。
この特徴は、webサーバーの外のプロセスでコマンドを実行するのに便利です。
使用方法¶
- ターミナルを開き、Kanboardのインストールされたディレクトリに移動する (例:
cd /var/www/kanboard)cd /var/www/kanboard) ./cliorphp cliのコマンドを実行する
Kanboard v1.2.11
使用方法:
使用方法:
コマンド [オプション] [引数]
オプション:
-h, --help このヘルプメッセージを表示する
-q, --quiet 何もメッセージを表示しない
-V, --version アプリケーションのバージョンを表示する
--ansi ANSI形式での出力を強制する
--no-ansi ANSI形式での出力を無効化
-n, --no-interaction 対話的な質問をしない
-v|vv|vvv, --verbose vの数が増える毎に詳細に出力する: -v は通常の出力で、-vv はもっと詳細に出力し、そして-vvvはデバッグ用です。
利用可能なコマンド:
cronjob 毎日のcronjobを実行する
css 最小限のCSSファイル
help コマンドのヘルプを画面に表示する
job 個々のジョブを実行する (stdin からペイロードを読み込む)
js 最小限のJavascriptファイル
list コマンドのリスト
version Kanboardのバージョンを表示
worker キューワーカーを実行する
db
db:migrate SQL マイグレーションを実行
db:version データベースのスキーマのバージョンを表示
エクスポート
export:daily-project-column-stats 毎日のプロジェクトのカラムの統計をCSVでエクスポート (1日でのカラム毎のタスク数)
export:subtasks サブタスクをCSVでエクスポート
export:tasks タスクをCSVでエクスポート
export:transitions タスクの推移をCSVでエクスポート
ロケール
locale:compare アプリケーションの翻訳を fr_FR のロケールと比較する
locale:sync fr_FR ロケールを元に全ての翻訳を同期させる
通知
notification:overdue-tasks 期限切れのタスクの通知を送る
プラグイン
plugin:install リモートのzipアーカイブからプラグインをインストールする
plugin:uninstall プラグインを削除する
plugin:upgrade インストール済みのプラグインを全て更新する
プロジェクト
projects:archive 1年間触られていないプロジェクトを無効化する
projects:archive-activities 1年以上前のプロジェクトのアクティビティを削除する
projects:daily-stats 全てのプロジェクトの毎日の統計を計算する
トリガー
trigger:tasks 全てのタスクのイベントのトリガーのスケジューラー
ユーザー
user:reset-2fa ユーザーの二要素認証を削除する
user:reset-password ユーザーのパスワードを変更する
利用可能なコマンド¶
タスクをCSVでエクスポート¶
使用方法:
./cli export:tasks <project_id> <start_date> <end_date>
例:
./cli export:tasks 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv
CSVデータは stdout に送られます。
サブタスクをCSVでエクスポート¶
使用方法:
./cli export:subtasks <project_id> <start_date> <end_date>
例:
./cli export:subtasks 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv
タスクの推移をCSVでエクスポート¶
使用方法:
./cli export:transitions <project_id> <start_date> <end_date>
例:
./cli export:transitions 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv
毎日の要約データをCSVでエクスポート¶
エクスポートされたデータは標準出力に表示されるでしょう:
./cli export:daily-project-column-stats <project_id> <start_date> <end_date>
例:
./cli export:daily-project-column-stats 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv
期限切れのタスクの通知を送る¶
通知を有効にしたすべてのユーザーにemailを送信します。
./cli notification:overdue-tasks
追加のパラメータ:
--show: 送信する通知を表示--group: グループの全ての期限切れタスクを一人のユーザーに一通のEmailで送信する--manager: すべての期限切れタスクをプロジェクト管理者に一通のEmailで送信-p|--project プロジェクトID|識別子: 指定したプロジェクトのみの通知を送信
また、``--show``フラグを使用することで、期限切れタスクを表示することもできます。
./cli 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 | |
+-----+---------+------------+------------+--------------+----------+
プロジェクトでふるい分ける場合の例:
./cli notification:overdue-tasks --project 123
もしくは、プロジェクト識別子を定義済みならば:
./cli notification:overdue-tasks --project MY_PROJECT
毎日の統計を計算する¶
このコマンドはプロジェクト毎に統計を計算します:
./cli projects:daily-stats
Run calculation for Project #0
Run calculation for Project #1
Run calculation for Project #10
タスクのトリガー¶
このコマンドは、"daily cronjob event"を個々のプロジェクトの未完了タスクに送ります。
./cli trigger:tasks
Trigger task event: project_id=2, nb_tasks=1
ユーザーの二要素認証を削除する¶
./cli user:reset-2fa my_user
プラグインをインストールする¶
./cli plugin:install https://github.com/kanboard/plugin-github-auth/releases/download/v1.0.1/GithubAuth-1.0.1.zip
注意:インストールされたファイルは、コマンドを実行したユーザーと同じアクセス権に設定されます
プラグインを削除する¶
./cli plugin:uninstall Budget
プラグインを更新する¶
./cli plugin:upgrade
* Updating plugin: Budget Planning
* Plugin up to date: Github Authentication
個々のジョブを実行する (たいていデバッグ目的)¶
echo 'RAW_JOB_DATA' | ./cli job
データベースのマイグレーションを実行する¶
DB_RUN_MIGRATIONS パラメーターを false に設定した場合、データベースのマイグレーションを手動で行う必要があります。
./cli db:migrate
データベースのスキーマのバージョンを確認する¶
./cli db:version
Current version: 95
Last version: 96