コマンドライン機能について

概要

RDEToolKitは、RDE構造化処理の開発と実行を支援する包括的なコマンドラインインターフェースを提供します。プロジェクトの初期化から、Excelインボイスの生成、アーカイブの作成まで、開発ワークフロー全体をサポートします。

前提条件

• Python 3.9以上
• rdetoolkitパッケージのインストール

利用可能なコマンド

init: スタートアッププロジェクトの作成

RDE構造化処理のスタートアッププロジェクトを作成します。

1

python3 -m rdetoolkit init

1

py -m rdetoolkit init

以下のディレクトリとファイル群が生成されます。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

container
├── data
│   ├── inputdata
│   ├── invoice
│   │   └── invoice.json
│   └── tasksupport
│       ├── invoice.schema.json
│       └── metadata-def.json
├── main.py
├── modules
└── requirements.txt

各ファイルの説明は以下の通りです。

• requirements.txt: 構造化プログラム構築で使用したいPythonパッケージを追加してください。必要に応じてpip installを実行してください。
• modules: 構造化処理で使用したいプログラムを格納してください。
• main.py: 構造化プログラムの起動処理を定義
• data/inputdata: 構造化処理対象データファイルを配置してください。
• data/invoice: ローカル実行させるためには空ファイルでも必要になります。
• data/tasksupport: 構造化処理の補助するファイル群を配置してください。

make-excelinvoice: ExcelInvoiceの生成

invoice.schema.jsonからExcelインボイスを生成します。

1

python3 -m rdetoolkit make-excelinvoice <invoice.schema.json path> -o <save file path> -m <file or folder>

1

py -m rdetoolkit make-excelinvoice <invoice.schema.json path> -o <save file path> -m <file or folder>

オプション

gen-config: rdeconfig.yamlテンプレートの生成

用意されているテンプレート、または対話形式の質問に基づいてrdeconfig.yamlを生成します。

1

python3 -m rdetoolkit gen-config [OUTPUT_DIR] --template <template> [--overwrite] [--lang <ja|en>]

1

py -m rdetoolkit gen-config [OUTPUT_DIR] --template <template> [--overwrite] [--lang <ja|en>]

利用できるテンプレートは以下の通りです。

• minimal（デフォルト）: システム設定とトレースバック設定のみを含む最小構成。
• full: multidata_tile設定を含む完全なテンプレート。
• multitile: extended_mode: "MultiDataTile"を有効化したテンプレート。
• rdeformat: extended_mode: "rdeformat"を有効化したテンプレート。
• smarttable: SmartTable設定を追加し、save_table_file: trueを設定。
• interactive: 対話形式で各設定項目を確認。--lang jaで日本語プロンプトに切り替え可能。

オプション

version: バージョン確認

rdetoolkitのバージョンを確認します。

1

python3 -m rdetoolkit version

1

py -m rdetoolkit version

artifact: RDE提出用アーカイブの作成

RDEに提出するためのアーカイブ（.zip）を作成します。指定したソースディレクトリを圧縮し、除外パターンに一致するファイルやディレクトリを除外します。

1

python3 -m rdetoolkit artifact --source-dir <ソースディレクトリ> --output-archive <出力アーカイブファイル> --exclude <除外パターン>

1

py -m rdetoolkit artifact --source-dir <ソースディレクトリ> --output-archive <出力アーカイブファイル> --exclude <除外パターン>

オプション

実行レポート

アーカイブが作成されると、以下のような実行レポートが生成されます：

• Dockerfileやrequirements.txtの存在確認
• 含まれるディレクトリとファイルのリスト
• コードスキャン結果（セキュリティリスクの検出）
• 外部通信チェック結果

実行レポートのサンプル：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

# Execution Report

**Execution Date:** 2025-04-08 02:58:44

- **Dockerfile:** [Exists]: 🐳　container/Dockerfile
- **Requirements:** [Exists]: 🐍 container/requirements.txt

## Included Directories

- container/requirements.txt
- container/Dockerfile
- container/vuln.py
- container/external.py

## Code Scan Results

### container/vuln.py

**Description**: Usage of eval() poses the risk of arbitrary code execution.

```python
def insecure():
    value = eval("1+2")
    print(value)

External Communication Check Results

container/external.py

1
2
3
4
5

1:
2: import requests
3: def fetch():
4:     response = requests.get("https://example.com")
5:     return response.text

次のステップ

• 構造化処理の概念を理解する
• 設定ファイルの作成方法を学ぶ
• APIリファレンスで詳細な機能を確認する