CLI commands for n8n
N8nにはコマンドラインインターフェイス（CLI）が含まれており、n8nエディタではなくCLIを使用して操作を実行できます。これには、ワークフローの開始、ワークフロー、および資格情報のエクスポートとインポートが含まれます。
CLI コマンドの実行
自己ホスト型N8nでCLIコマンドを使用できます。 n8nのインストール方法によっては、命令の実行方法に違いがあります。
•
Npm: n8n
コマンドを直接使用できます。このマニュアルでは、次の例でこの機能を使用しています。
•
ドッカー: N8n
コマンドはドッカーコンテナ内で使用できます。
docker exec -u node -it <n8n-container-name> <n8n-cli-command>
ワークフローの開始
•
CLIを使用して直接ワークフローを開始できます。保存したワークフローをIDで実行します。
•
ワークフローIDはURLで確認可能。
n8n execute --id <ID>
n8n execute --id NGgtX67xWcwx2a3I
•
下のドッカーからExecに直接入力して実行可能。
ワークフローのアクティブ状態の変更
CLIを使用してワークフローのアクティブ状態を変更できます。
再起動が必要
このコマンドはN8nデータベースで動作します。 n8nの実行中にそれを実行すると、n8nを再起動するまで変更は適用されません。
ワークフローのIDによるアクティブ状態をFalseに設定します。
n8n update:workflow --id=<ID> --active=falseワークフローのIDによるアクティブ状態をtrueに設定します。
n8n update:workflow --id=<ID> --active=trueすべてのワークフローに対してアクティブ状態を偽に設定します。
n8n update:workflow --all --active=falseすべてのワークフローに対してアクティブ状態をTrueに設定します。
n8n update:workflow --all --active=trueワークフローと資格情報のエクスポート
CLIを使用して、n8nからワークフローと資格情報をエクスポートできます。
コマンドフラグ：
Flag | Description |
--Help | Help prompt. |
--All | Exports all workflows/credentials. |
--Backup | Sets --all --pretty --separate for backups. You can optionally set --output. |
--Id | The ID of the workflow to export. |
--Output | Outputs file name or directory if using separate files. |
--Pretty | Formats the output in an easier to read fashion. |
--Separate | Exports one file per workflow (useful for versioning). Must set a directory using --output. |
--Decrypted | Exports the credentials in a plain text format. |
ワークフロー
すべてのワークフローを標準出力（ターミナル）にエクスポートします。
n8n export:workflow --allワークフローをIDでエクスポートし、出力ファイル名を指定します。
n8n export:workflow --id=<ID> --output=file.jsonすべてのワークフローを単一ファイルの特定のディレクトリにエクスポートします。
n8n export:workflow --all --output=backups/latest/file.jsonを使用して、すべてのワークフローを特定のディレクトリにエクスポートします。 --Backupフラグ（上記の詳細）：
n8n export:workflow --backup --output=backups/latest/資格証明
すべての資格情報を標準出力（ターミナル）にエクスポートします。
n8n export:credentials --allIDごとに資格情報をエクスポートし、出力ファイル名を指定します。
n8n export:credentials --id=<ID> --output=file.json単一ファイルのすべての資格情報を特定のディレクトリにエクスポートします。
n8n export:credentials --all --output=backups/latest/file.jsonを使用して、すべての資格情報を特定のディレクトリにエクスポートします。 --Backupフラグ（上記の詳細）：
n8n export:credentials --backup --output=backups/latest/すべての資格情報をプレーンテキスト形式でエクスポートします。これを使用して、構成ファイルに異なる秘密鍵があるインストールから別のインストールに移行できます。
•
機密情報
◦
すべての機密情報はファイルで確認できます。
n8n export:credentials --all --decrypted --output=backups/decrypted.jsonワークフローと資格情報のインポート
CLIを使用して、n8nからワークフローと資格情報をインポートできます。
IDの更新
ワークフローと資格情報をエクスポートすると、N8nはIDもエクスポートします。既存のデータベースに同じIDを持つワークフローと資格情報がある場合は、上書きされます。これを防ぐには、インポートする前にIDを削除または変更してください。
利用可能なフラグ：
Flag | Description |
--Help | Help prompt. |
--Input | Input file name or directory if you use --separate. |
--ProjectId | Import the workflow or credential to the specified project. Can't be used with --userId 。 |
--Separate | Imports *.json files from directory provided by --input. |
--UserId | Import the workflow or credential to the specified user. Can't be used with --projectId 。 |
SQLiteへの移行
N8nはワークフローと資格情報の名前を128文字に制限しますが、SQLiteはサイズ制限を適用しません。
この場合、インポートプロセス中に列名と比較してデータが長すぎるなどのエラーが発生する可能性があります。
この場合、N8nインタフェースで名前を編集し、再エクスポートまたはインポートする前にJSONファイルを直接編集できます。
ワークフロー
特定のファイルからワークフローをインポートする：
n8n import:workflow --input=file.json指定したディレクトリからすべてのワークフローファイルをJSONにインポートします。
n8n import:workflow --separate --input=backups/latest/資格証明
特定のファイルから資格情報を取得する：
n8n import:credentials --input=file.json指定したディレクトリからすべての資格情報ファイルをJSONにインポートします。
n8n import:credentials --separate --input=backups/latest/ライセンス
クリア
N8nのデータベースから既存のライセンスを削除し、n8nを基本機能にリセットします。
n8n license:clear情報
既存のライセンスに関する情報を表示します。
n8n license:infoユーザー管理
N8n CLIを使用してユーザー管理をリセットできます。これにより、ユーザー管理はプリセット状態に戻ります。すべてのユーザーアカウントを削除します。
パスワードを忘れて電子メールでパスワードをリセットするようにSMTPが設定されていない場合は、この方法を使用してください。
n8n user-management:resetユーザーの MFA を無効にする
ユーザーが回復コードを紛失した場合は、このコマンドでユーザーのMFAを無効にできます。これにより、ユーザーは再度ログインしてMFAをリセットできます。
n8n mfa:disable --email=johndoe@example.comLDAPを無効にする
次のコマンドを使用してLDAP設定をリセットできます。
n8n ldap:resetセキュリティ監査
n8n auditWorkflow Postgres DBへの接続
•
データベース構造はここで確認できます。
•
Docker-compose.ymlファイルで実行されたPostgresにアクセスするには、次の方法を使用できます。
•
Iterm2などの別の端末で実行するには、右側の「Open in external terminal」を押します。
•
/#で出るとコンテナ内部セルに接続したもの。
•
コンテナ内でPostgresデータベースにアクセスするには、psqlコマンドを使用する必要があります。 psqlコマンドを使用するには、次のように入力します。
◦
: Docker-compose.yml で設定した POSTGRES_USER。
◦
：Docker-compose.ymlで設定したPOSTGRES_DB。
psql -U <username> -d <database>•
Docker-compose.ymlの初期設定は次のとおりです。
◦
POSTGRES_USER=root
POSTGRES_PASSWORD=password
POSTGRES_DB=n8n
POSTGRES_PASSWORD=password
POSTGRES_DB=n8n
•
そして、 Psql -U root -d n8nと入力してください。
•
\ Dtコマンドは、現在のデータベースのテーブルのリストを表示します。
1. テーブルの構造を確認する
•
特定のテーブルの構造（列情報、データ型など）を確認するには、\ D を使用します。
•
\D user
1.
テーブルのデータを照会する
•
テーブルのデータを照会するには、一般的なSQLクエリを使用できます。たとえば、userテーブルからすべてのデータを取得するには：
•
SELECT * FROM user;
1.
追加、編集、削除
a.
INSERT INTO user(id, name, email) VALUES(1, 'Alice', 'alice@example.com');
b.
UPDATE user SET name = 'Bob' WHERE id = 1;
c.
DELETE FROM user WHERE id = 1;
2.
シェルを出る
•
\Qで終了します。