Command Reference ( cmdbox mode )

List of cmdbox mode commands.

cmdbox ( down ) : `cmdbox -m cmdbox -c down <Option>`

Stops the container.

Option	Type	Multi	Required	Default	Choices	Description
-C, --container <container>	str					Specify the container name.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": "string"
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field	Type	Required	Default	Description
success	Data \| null	no	null	成功した場合の結果
success.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
success.data	str \| null	no	null	処理結果のデータ
warn	dict[str, any] \| list[any] \| Data \| str \| bool \| null	no	null	警告がある場合の結果
warn.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
error	dict[str, any] \| list[any] \| Data \| str \| bool \| null	no	null	エラーがある場合の結果
error.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
output_schema	dict[str, any] \| null	no	null	スキーマ情報
end	bool \| null	no	null	終了フラグ

cmdbox ( exec ) : `cmdbox -m cmdbox -c exec <Option>`

Execute any command inside the container.

Option	Type	Required	Default	Description
-C, --container <container>	str			Specify the container name.
--compose_path <compose_path>	file			Specify the docker-compose.yml file.
--command <command>	str	required	False	Specify the command to execute.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": "string"
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field	Type	Required	Default	Description
success	Data \| null	no	null	成功した場合の結果
success.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
success.data	str \| null	no	null	処理結果のデータ
warn	dict[str, any] \| list[any] \| Data \| str \| bool \| null	no	null	警告がある場合の結果
warn.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
error	dict[str, any] \| list[any] \| Data \| str \| bool \| null	no	null	エラーがある場合の結果
error.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
output_schema	dict[str, any] \| null	no	null	スキーマ情報
end	bool \| null	no	null	終了フラグ

cmdbox ( initdata_install ) : `cmdbox -m cmdbox -c initdata_install <Option>`

Registers initial data on the client or server side.

Option	Type	Multi	Required	Default	Choices	Description
--host <host>	str		required	localhost		Specify the service host of the Redis server.
--port <port>	int		required	6379		Specify the service port of the Redis server.
--password <password>	passwd		required	password		Specify the access password of the Redis server (optional). If omitted, password is used.
--svname <svname>	str		required	cmdbox		Specify the service name of the inference server. If omitted, server is used.
--svpath <svpath>	file		required	/		Specify the destination path under the server's data folder.
--fwpath <fwpath>	file	multi	required			Specify the path to determine whether the specified path is out of bounds. If it is not under this path, it will result in an error.
--rjpath <rjpath>	file	multi				If the specified path matches the requested path, access will be denied. Interpreted as a regular expression.
--scope <scope>	str		required	client	client \| current \| server	Specify the scope. client refers to the client side, and server refers to the server side. current refers to the current directory.
--initdata_path <initdata_path>	dir	multi				Specify the path(s) of the initial data file(s) to install.
--mkdir <mkdir>	bool			True	True \| False	If there is no in between folder, create one.
--overwrite <overwrite>	bool			False	True \| False	Overwrites the file even if it exists at the upload destination.
--retry_count <retry_count>	int			3		Specifies the number of reconnections to the Redis server. If less than 0 is specified, reconnection is forever.
--retry_interval <retry_interval>	int			5		Specifies the number of seconds before reconnecting to the Redis server.
--timeout <timeout>	int			60		Specify the maximum waiting time until the server responds.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": [
      {
        "file": "string",
        "result": {}
      }
    ]
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field	Type	Required	Default	Description
success	Data \| null	no	null	成功した場合の結果
success.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
success.data	list[FileResult] \| null	no	null	アップロード結果リスト
warn	dict[str, any] \| list[any] \| Data \| str \| bool \| null	no	null	警告がある場合の結果
warn.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
error	dict[str, any] \| list[any] \| Data \| str \| bool \| null	no	null	エラーがある場合の結果
error.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
output_schema	dict[str, any] \| null	no	null	スキーマ情報
end	bool \| null	no	null	終了フラグ

cmdbox ( load ) : `cmdbox -m cmdbox -c load <Option>`

Loads the container image.

Option	Type	Description
--image_file <image_file>	file	Specify the source image file.
-C, --container <container>	str	Specify the container name.
--install_tag <install_tag>	str	If specified, you can add to the tag name of the docker image to create.
--compose_path <compose_path>	file	Specify the docker-compose.yml file.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": "string"
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field	Type	Required	Default	Description
success	Data \| null	no	null	成功した場合の結果
success.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
success.data	str \| null	no	null	処理結果のデータ
warn	dict[str, any] \| list[any] \| Data \| str \| bool \| null	no	null	警告がある場合の結果
warn.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
error	dict[str, any] \| list[any] \| Data \| str \| bool \| null	no	null	エラーがある場合の結果
error.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
output_schema	dict[str, any] \| null	no	null	スキーマ情報
end	bool \| null	no	null	終了フラグ

cmdbox ( logs ) : `cmdbox -m cmdbox -c logs <Option>`

Displays the logs of the container.

Option	Type	Default	Choices	Description
-C, --container <container>	str			Specify the container name.
-F, --follow <follow>	bool	False	True \| False	Follow log output.
--number <number>	int	20		Outputs the specified number of lines from the end of the log.
--compose_path <compose_path>	file			Specify the docker-compose.yml file.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": "string"
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field	Type	Required	Default	Description
success	Data \| null	no	null	成功した場合の結果
success.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
success.data	str \| null	no	null	処理結果のデータ
warn	dict[str, any] \| list[any] \| Data \| str \| bool \| null	no	null	警告がある場合の結果
warn.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
error	dict[str, any] \| list[any] \| Data \| str \| bool \| null	no	null	エラーがある場合の結果
error.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
output_schema	dict[str, any] \| null	no	null	スキーマ情報
end	bool \| null	no	null	終了フラグ

cmdbox ( pgsql_install ) : `cmdbox -m cmdbox -c pgsql_install <Option>`

Installs the PostgreSQL server.

Option	Type	Required	Default	Description
--install_pgsqlver <install_pgsqlver>	str	required	18	Specify the PostgreSQL version.
--install_from <install_from>	str		postgres:18.2	Specify the source PostgreSQL image to install.
--install_tag <install_tag>	str			If specified, you can add to the tag name of the docker image to create.
--no_install_pgvector <no_install_pgvector>	bool		False	Specify whether not to install the pgvector extension.
--install_pgvector_tag <install_pgvector_tag>	str		v0.8.2	Specify the tag name in the pgvector extension repository https://github.com/pgvector/pgvector.git.
--no_install_age <no_install_age>	bool		False	Specify whether not to install the Apache AGE extension.
--install_age_tag <install_age_tag>	str		release/PG18/1.7.0	Specify the tag name in the Apache AGE extension repository https://github.com/apache/age.git.
--no_install_pgcron <no_install_pgcron>	bool		False	Specify whether not to install the pg_cron extension.
--install_pgcron_tag <install_pgcron_tag>	str		v1.6.7	Specify the tag name in the pg_cron extension repository https://github.com/citusdata/pg_cron.git.
--compose_path <compose_path>	file			Specify the docker-compose.yml file.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": "string"
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field	Type	Required	Default	Description
success	Data \| null	no	null	成功した場合の結果
success.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
success.data	str \| null	no	null	処理結果のデータ
warn	dict[str, any] \| list[any] \| Data \| str \| bool \| null	no	null	警告がある場合の結果
warn.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
error	dict[str, any] \| list[any] \| Data \| str \| bool \| null	no	null	エラーがある場合の結果
error.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
output_schema	dict[str, any] \| null	no	null	スキーマ情報
end	bool \| null	no	null	終了フラグ

cmdbox ( pgsql_load ) : `cmdbox -m cmdbox -c pgsql_load <Option>`

Loads the cmdbox PostgreSQL.

Option	Type	Required	Default	Description
--image_file <image_file>	file			Specify the source image file.
--install_pgsqlver <install_pgsqlver>	str	required	18	Specify the PostgreSQL version.
--install_tag <install_tag>	str			If specified, you can add to the tag name of the docker image to create.
--compose_path <compose_path>	file			Specify the docker-compose.yml file.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": "string"
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field	Type	Required	Default	Description
success	Data \| null	no	null	成功した場合の結果
success.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
success.data	str \| null	no	null	処理結果のデータ
warn	dict[str, any] \| list[any] \| Data \| str \| bool \| null	no	null	警告がある場合の結果
warn.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
error	dict[str, any] \| list[any] \| Data \| str \| bool \| null	no	null	エラーがある場合の結果
error.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
output_schema	dict[str, any] \| null	no	null	スキーマ情報
end	bool \| null	no	null	終了フラグ

cmdbox ( reboot ) : `cmdbox -m cmdbox -c reboot <Option>`

Reboots the container.

Option	Type	Multi	Required	Default	Choices	Description
-C, --container <container>	str					Specify the container name.
--compose_path <compose_path>	file					Specify the docker-compose.yml file.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": "string"
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field	Type	Required	Default	Description
success	Data \| null	no	null	成功した場合の結果
success.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
success.data	str \| null	no	null	処理結果のデータ
warn	dict[str, any] \| list[any] \| Data \| str \| bool \| null	no	null	警告がある場合の結果
warn.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
error	dict[str, any] \| list[any] \| Data \| str \| bool \| null	no	null	エラーがある場合の結果
error.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
output_schema	dict[str, any] \| null	no	null	スキーマ情報
end	bool \| null	no	null	終了フラグ

cmdbox ( redis_install ) : `cmdbox -m cmdbox -c redis_install <Option>`

Installs the cmdbox Redis.

Option	Type	Default	Description
--install_from <install_from>	str	ubuntu/redis:latest	Specify the source Redis image to install.
--install_tag <install_tag>	str		If specified, you can add to the tag name of the docker image to create.
--compose_path <compose_path>	file		Specify the docker-compose.yml file.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": "string"
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field	Type	Required	Default	Description
success	Data \| null	no	null	成功した場合の結果
success.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
success.data	str \| null	no	null	処理結果のデータ
warn	dict[str, any] \| list[any] \| Data \| str \| bool \| null	no	null	警告がある場合の結果
warn.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
error	dict[str, any] \| list[any] \| Data \| str \| bool \| null	no	null	エラーがある場合の結果
error.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
output_schema	dict[str, any] \| null	no	null	スキーマ情報
end	bool \| null	no	null	終了フラグ

cmdbox ( redis_load ) : `cmdbox -m cmdbox -c redis_load <Option>`

Loads the cmdbox Redis.

Option	Type	Description
--image_file <image_file>	file	Specify the source image file.
--install_tag <install_tag>	str	If specified, you can add to the tag name of the docker image to create.
--compose_path <compose_path>	file	Specify the docker-compose.yml file.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": "string"
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field	Type	Required	Default	Description
success	Data \| null	no	null	成功した場合の結果
success.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
success.data	str \| null	no	null	処理結果のデータ
warn	dict[str, any] \| list[any] \| Data \| str \| bool \| null	no	null	警告がある場合の結果
warn.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
error	dict[str, any] \| list[any] \| Data \| str \| bool \| null	no	null	エラーがある場合の結果
error.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
output_schema	dict[str, any] \| null	no	null	スキーマ情報
end	bool \| null	no	null	終了フラグ

cmdbox ( save ) : `cmdbox -m cmdbox -c save <Option>`

Saves the container image.

Option	Type	Description
-C, --container <container>	str	Specify the container name.
--image_file <image_file>	file	Specify the destination image file.
--install_tag <install_tag>	str	If specified, you can add to the tag name of the docker image to create.
--compose_path <compose_path>	file	Specify the docker-compose.yml file.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": "string"
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field	Type	Required	Default	Description
success	Data \| null	no	null	成功した場合の結果
success.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
success.data	str \| null	no	null	処理結果のデータ
warn	dict[str, any] \| list[any] \| Data \| str \| bool \| null	no	null	警告がある場合の結果
warn.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
error	dict[str, any] \| list[any] \| Data \| str \| bool \| null	no	null	エラーがある場合の結果
error.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
output_schema	dict[str, any] \| null	no	null	スキーマ情報
end	bool \| null	no	null	終了フラグ

cmdbox ( server_install ) : `cmdbox -m cmdbox -c server_install <Option>`

Install the cmdbox container.

Option	Type	Multi	Required	Default	Choices	Description
--data <data>	dir			C:Usershama.cmdbox		When omitted, $HONE/.cmdbox is used.
--install_cmdbox <install_cmdbox>	str			cmdbox==0.8.0		When omitted, cmdbox==0.8.0 is used.
--install_from <install_from>	str					Specify the FROM image that will be the source of the docker image to be created.
--install_no_python <install_no_python>	bool			False	True \| False	Do not install python.
--install_compile_python <install_compile_python>	bool			False	True \| False	Compile and install python3; if install_no_python is specified, it is preferred.
--install_tag <install_tag>	str					If specified, you can add to the tag name of the docker image to create.
--install_use_gpu <install_use_gpu>	bool			False	True \| False	Install with a module configuration that uses the GPU.
--tts_engine <tts_engine>	str		required	voicevox	voicevox	Specify the TTS engine to use.
--voicevox_ver <voicevox_ver>	str			0.16.3	0.16.3	Specify the version of VOICEVOX to use.
--voicevox_whl <voicevox_whl>	str			voicevox_core-0.16.3-cp310-abi3-manylinux_2_34_x86_64.whl	voicevox_core-0.16.3-cp310-abi3-win32.whl \| voicevox_core-0.16.3-cp310-abi3-win_amd64.whl \| voicevox_core-0.16.3-cp310-abi3-macosx_10_12_x86_64.whl \| voicevox_core-0.16.3-cp310-abi3-macosx_11_0_arm64.whl \| voicevox_core-0.16.3-cp310-abi3-manylinux_2_34_aarch64.whl \| voicevox_core-0.16.3-cp310-abi3-manylinux_2_34_x86_64.whl	Specify the VOICEVOX wheel file to use.
--init_extra <init_extra>	str	multi				Specify the command to be executed immediately after “from”.
--run_extra_pre <run_extra_pre>	str	multi				Specify additional commands to run before install_extra execution.
--run_extra_post <run_extra_post>	str	multi				Specify additional commands to run after install_extra execution.
--install_extra <install_extra>	str	multi				Specify additional packages to install.
--compose_path <compose_path>	file					Specify the docker-compose.yml file.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": "string"
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field	Type	Required	Default	Description
success	Data \| null	no	null	成功した場合の結果
success.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
success.data	str \| null	no	null	処理結果のデータ
warn	dict[str, any] \| list[any] \| Data \| str \| bool \| null	no	null	警告がある場合の結果
warn.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
error	dict[str, any] \| list[any] \| Data \| str \| bool \| null	no	null	エラーがある場合の結果
error.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
output_schema	dict[str, any] \| null	no	null	スキーマ情報
end	bool \| null	no	null	終了フラグ

cmdbox ( server_load ) : `cmdbox -m cmdbox -c server_load <Option>`

Load the cmdbox container image.

Option	Type	Default	Choices	Description
--data <data>	dir	C:Usershama.cmdbox		When omitted, $HONE/.cmdbox is used.
--image_file <image_file>	file			Specify the source image file.
--install_tag <install_tag>	str			If specified, you can add to the tag name of the docker image to create.
--install_use_gpu <install_use_gpu>	bool	False	True \| False	Install with a module configuration that uses the GPU.
--compose_path <compose_path>	file			Specify the docker-compose.yml file.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": "string"
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field	Type	Required	Default	Description
success	Data \| null	no	null	成功した場合の結果
success.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
success.data	str \| null	no	null	処理結果のデータ
warn	dict[str, any] \| list[any] \| Data \| str \| bool \| null	no	null	警告がある場合の結果
warn.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
error	dict[str, any] \| list[any] \| Data \| str \| bool \| null	no	null	エラーがある場合の結果
error.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
output_schema	dict[str, any] \| null	no	null	スキーマ情報
end	bool \| null	no	null	終了フラグ

cmdbox ( setup ) : `cmdbox -m cmdbox -c setup <Option>`

Reads a setup file and executes the listed commands in order.

Option	Type	Multi	Required	Default	Description
--host <host>	str		required	localhost	Specify the service host of the Redis server.
--port <port>	int		required	6379	Specify the service port of the Redis server.
--password <password>	passwd		required	password	Specify the access password of the Redis server (optional). If omitted, password is used.
--data <data>	dir			C:Usershama.cmdbox	When omitted, $HOME/.cmdbox is used.
--chopt <chopt>	dict	multi			Change the options for the commands specified in the YML file. Specify a dictionary where the option name is the key and the new value is the value. Example: --chopt host=redis
--retry_count <retry_count>	int			20	Specifies the number of reconnections to the Redis server.If less than 0 is specified, reconnection is forever.
--retry_interval <retry_interval>	int			5	Specifies the number of seconds before reconnecting to the Redis server.
--setup_file <setup_file>	file		required	.cmdbox_initdata/setup.yml	Specify the path to the setup file. Default is .cmdbox_initdata/setup.yml.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": [
      {
        "name": "string",
        "description": "string",
        "status": "string",
        "result": {}
      }
    ]
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field	Type	Required	Default	Description
success	Data \| null	no	null	成功した場合の結果
success.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
success.data	list[SetupResult] \| null	no	null	各セットアップの実行結果リスト
warn	dict[str, any] \| list[any] \| Data \| str \| bool \| null	no	null	警告がある場合の結果
warn.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
error	dict[str, any] \| list[any] \| Data \| str \| bool \| null	no	null	エラーがある場合の結果
error.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
output_schema	dict[str, any] \| null	no	null	スキーマ情報
end	bool \| null	no	null	終了フラグ

cmdbox ( uninstall ) : `cmdbox -m cmdbox -c uninstall <Option>`

Uninstalls the container.

Option	Type	Description
-C, --container <container>	str	Specify the container name.
--install_tag <install_tag>	str	If specified, you can add to the tag name of the docker image to create.
--compose_path <compose_path>	file	Specify the docker-compose.yml file.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": "string"
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field	Type	Required	Default	Description
success	Data \| null	no	null	成功した場合の結果
success.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
success.data	str \| null	no	null	処理結果のデータ
warn	dict[str, any] \| list[any] \| Data \| str \| bool \| null	no	null	警告がある場合の結果
warn.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
error	dict[str, any] \| list[any] \| Data \| str \| bool \| null	no	null	エラーがある場合の結果
error.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
output_schema	dict[str, any] \| null	no	null	スキーマ情報
end	bool \| null	no	null	終了フラグ

cmdbox ( up ) : `cmdbox -m cmdbox -c up <Option>`

Starts the container.

Option	Type	Multi	Required	Default	Choices	Description
-C, --container <container>	str					Specify the container name.
--compose_path <compose_path>	file					Specify the docker-compose.yml file.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": "string"
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field	Type	Required	Default	Description
success	Data \| null	no	null	成功した場合の結果
success.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
success.data	str \| null	no	null	処理結果のデータ
warn	dict[str, any] \| list[any] \| Data \| str \| bool \| null	no	null	警告がある場合の結果
warn.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
error	dict[str, any] \| list[any] \| Data \| str \| bool \| null	no	null	エラーがある場合の結果
error.performance	list[KeyVal] \| null	no	null	パフォーマンス情報のリスト
output_schema	dict[str, any] \| null	no	null	スキーマ情報
end	bool \| null	no	null	終了フラグ

Command Reference ( cmdbox mode )

cmdbox ( down ) : cmdbox -m cmdbox -c down <Option>

cmdbox ( exec ) : cmdbox -m cmdbox -c exec <Option>

cmdbox ( initdata_install ) : cmdbox -m cmdbox -c initdata_install <Option>

cmdbox ( load ) : cmdbox -m cmdbox -c load <Option>

cmdbox ( logs ) : cmdbox -m cmdbox -c logs <Option>

cmdbox ( pgsql_install ) : cmdbox -m cmdbox -c pgsql_install <Option>

cmdbox ( pgsql_load ) : cmdbox -m cmdbox -c pgsql_load <Option>

cmdbox ( reboot ) : cmdbox -m cmdbox -c reboot <Option>

cmdbox ( redis_install ) : cmdbox -m cmdbox -c redis_install <Option>

cmdbox ( redis_load ) : cmdbox -m cmdbox -c redis_load <Option>

cmdbox ( save ) : cmdbox -m cmdbox -c save <Option>

cmdbox ( server_install ) : cmdbox -m cmdbox -c server_install <Option>

cmdbox ( server_load ) : cmdbox -m cmdbox -c server_load <Option>

cmdbox ( setup ) : cmdbox -m cmdbox -c setup <Option>

cmdbox ( uninstall ) : cmdbox -m cmdbox -c uninstall <Option>

cmdbox ( up ) : cmdbox -m cmdbox -c up <Option>

cmdbox ( down ) : `cmdbox -m cmdbox -c down <Option>`

cmdbox ( exec ) : `cmdbox -m cmdbox -c exec <Option>`

cmdbox ( initdata_install ) : `cmdbox -m cmdbox -c initdata_install <Option>`

cmdbox ( load ) : `cmdbox -m cmdbox -c load <Option>`

cmdbox ( logs ) : `cmdbox -m cmdbox -c logs <Option>`

cmdbox ( pgsql_install ) : `cmdbox -m cmdbox -c pgsql_install <Option>`

cmdbox ( pgsql_load ) : `cmdbox -m cmdbox -c pgsql_load <Option>`

cmdbox ( reboot ) : `cmdbox -m cmdbox -c reboot <Option>`

cmdbox ( redis_install ) : `cmdbox -m cmdbox -c redis_install <Option>`

cmdbox ( redis_load ) : `cmdbox -m cmdbox -c redis_load <Option>`

cmdbox ( save ) : `cmdbox -m cmdbox -c save <Option>`

cmdbox ( server_install ) : `cmdbox -m cmdbox -c server_install <Option>`

cmdbox ( server_load ) : `cmdbox -m cmdbox -c server_load <Option>`

cmdbox ( setup ) : `cmdbox -m cmdbox -c setup <Option>`

cmdbox ( uninstall ) : `cmdbox -m cmdbox -c uninstall <Option>`

cmdbox ( up ) : `cmdbox -m cmdbox -c up <Option>`