Command Line Interface

Overview

RDEToolKit provides a comprehensive command-line interface to support the development and execution of RDE structured processing. It supports the entire development workflow from project initialization to Excel invoice generation and archive creation.

Prerequisites

• Python 3.9 or higher
• rdetoolkit package installation

Available Commands

init: Create Startup Project

Creates a startup project for RDE structured processing.

1

python3 -m rdetoolkit init [PATH options]

1

py -m rdetoolkit init [PATH options]

The following directories and files will be generated:

 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

Description of each file:

• requirements.txt: Add Python packages you want to use for structured program construction. Run pip install as needed.
• modules: Store programs you want to use for structured processing.
• main.py: Define startup processing for structured programs
• data/inputdata: Place data files to be processed by structured processing.
• data/invoice: Required for local execution, even if empty.
• data/tasksupport: Place files that support structured processing.

Template-based Initialization

Pass --template <path> to reuse your own boilerplate. The path can point to either:

• A directory that contains pyproject.toml or rdeconfig.yaml/rdeconfig.yml
• A direct path to one of the files above

When --template . is used, the command searches for pyproject.toml in the current directory first.
The configuration file must define template paths under [tool.rdetoolkit.init] (pyproject) or an init block (rdeconfig):

1
2
3
4
5

[tool.rdetoolkit.init]
entry_point = "templates/main.py"
modules = "templates/modules"
tasksupport = "templates/tasksupport"
inputdata = "templates/inputdata"

Key meaning:

• entry_point: File copied to container/main.py.
• modules: File or directory copied under container/modules/.
• tasksupport: File or directory mirrored to both container/data/tasksupport/ and templates/tasksupport/.
• inputdata: Directory copied into container/data/inputdata/ and input/inputdata/.

Relative paths are resolved from the configuration file location, so template repositories stay portable.

Specify template paths directly with PATH options

If you prefer not to store personal paths in config files, pass PATH options directly (can be combined). CLI-specified paths override values from config files; existing pyproject.toml / rdeconfig.yaml(yml) will be updated, or a new pyproject.toml will be created when missing.

Relative paths are saved from the current working directory. CLI-specified paths override values from config files.

Sample output with PATH options

Example run with templates under tpl/:

1
2
3
4
5
6

python3 -m rdetoolkit init \
  --entry-point tpl/custom_main.py \
  --modules tpl/modules \
  --tasksupport tpl/tasksupport \
  --inputdata tpl/inputdata \
  --other tpl/extra.txt --other tpl/extras

Output (paths vary by environment):

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

Ready to develop a structured program for RDE.
Created from template: /private/tmp/rdt-init-check/container/main.py
Created: /private/tmp/rdt-init-check/container/requirements.txt
Created: /private/tmp/rdt-init-check/container/Dockerfile
Populated /private/tmp/rdt-init-check/container/modules from template directory: /private/tmp/rdt-init-check/tpl/modules
Created: /private/tmp/rdt-init-check/container/data/invoice/invoice.json
Populated /private/tmp/rdt-init-check/container/data/tasksupport from template directory: /private/tmp/rdt-init-check/tpl/tasksupport
Populated /private/tmp/rdt-init-check/templates/tasksupport from template directory: /private/tmp/rdt-init-check/tpl/tasksupport
Populated /private/tmp/rdt-init-check/container/data/inputdata from template directory: /private/tmp/rdt-init-check/tpl/inputdata
Populated /private/tmp/rdt-init-check/input/inputdata from template directory: /private/tmp/rdt-init-check/tpl/inputdata
Copied template file /private/tmp/rdt-init-check/tpl/extra.txt into /private/tmp/rdt-init-check/container
Populated /private/tmp/rdt-init-check/container/extras from template directory: /private/tmp/rdt-init-check/tpl/extras
Created: /private/tmp/rdt-init-check/input/invoice/invoice.json

After the run, [tool.rdetoolkit.init] (or init in rdeconfig.yaml) is written with the provided paths, stored as relative paths when possible.

make-excelinvoice: Generate Excel Invoice

Generates an Excel invoice from invoice.schema.json.

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>

Options

gen-config: Generate rdeconfig.yaml Templates

Creates an rdeconfig.yaml file based on predefined templates or an interactive questionnaire.

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>]

Available templates:

• minimal (default): System and traceback keys only.
• full: Includes multidata_tile defaults.
• multitile: Enables extended_mode: "MultiDataTile".
• rdeformat: Enables extended_mode: "rdeformat".
• smarttable: Adds SmartTable settings with save_table_file: true.
• interactive: Guides you through each option. Use --lang ja for Japanese prompts.

Options

version: Version Check

Check the version of rdetoolkit.

1

python3 -m rdetoolkit version

1

py -m rdetoolkit version

artifact: Create RDE Submission Archive

Creates an archive (.zip) for submission to RDE. Compresses the specified source directory and excludes files or directories that match exclusion patterns.

1

python3 -m rdetoolkit artifact --source-dir <source directory> --output-archive <output archive file> --exclude <exclusion pattern>

1

py -m rdetoolkit artifact --source-dir <source directory> --output-archive <output archive file> --exclude <exclusion pattern>

Options

Execution Report

When an archive is created, the following execution report is generated:

• Existence check of Dockerfile and requirements.txt
• List of included directories and files
• Code scan results (security risk detection)
• External communication check results

Sample execution report:

 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

Shell Completion

Shell completion functionality is available to help complete command and option names. Press the Tab key to display candidate suggestions.

Supported Shells

• Bash
• Zsh
• Fish
• PowerShell

Installation

Use the --install-completion option to install completion for your current shell:

1

python -m rdetoolkit --install-completion

After execution, restart your shell to enable the completion feature.

1
2

# Restart shell
exec $SHELL

Manual Installation

To review the completion script before installing manually, use the --show-completion option:

1

python -m rdetoolkit --show-completion

Add the displayed script to your shell configuration file.

For Bash

1
2

python -m rdetoolkit --show-completion >> ~/.bashrc
source ~/.bashrc

For Zsh

1
2

python -m rdetoolkit --show-completion >> ~/.zshrc
source ~/.zshrc

Usage Examples

After installing the completion feature, press the Tab key to display candidates.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

# Command name completion
python -m rdetoolkit <Tab>
# → init, version, gen-config, etc. will be displayed

# Option name completion
python -m rdetoolkit gen-config --<Tab>
# → --template, --overwrite, --lang, etc. will be displayed

# Option value completion
python -m rdetoolkit gen-config --template <Tab>
# → static, interactive will be displayed

Uninstallation

To remove the completion feature, delete the corresponding lines from your shell configuration file.

For Bash, remove lines similar to the following from ~/.bashrc; for Zsh, from ~/.zshrc:

1

eval "$(_RDETOOLKIT_COMPLETE=bash_source python -m rdetoolkit)"

Restart your shell after removal.

Next Steps

• Understand Structuring Processing Concepts
• Learn how to create Configuration Files
• Check detailed features in API Reference