Command Reference ( skill mode )
List of skill mode commands.
skill ( create ) : cmdbox -m skill -c create <Option>
Create an Agent Skill zip from a command definition file.
Option |
Type |
Multi |
Required |
Default |
Choices |
Description |
|---|---|---|---|---|---|---|
--data <data> |
dir |
C:Usershama.cmdbox |
When omitted, $HOME/.cmdbox is used. |
|||
--from_cmd_title <from_cmd_title> |
str |
required |
Specify the command title to convert into a skill. |
|||
--skill_name <skill_name> |
str |
Specify the skill name. If omitted, generated from from_cmd_title. |
||||
--skill_instruction <skill_instruction> |
text |
Specify the instruction body in SKILL.md. |
||||
--output_file <output_file> |
file |
Output zip file path. If omitted, creates <skill_name>.zip in current directory. |
||||
--overwrite <overwrite> |
bool |
False |
True | False |
Overwrite when output file already exists. |
Output Schema
This command implements output_schema() returning Result model.
{
"success": {
"save_mode": "string",
"performance": [
{
"key": "string",
"value": null
}
],
"from_cmd_title": "string",
"skill_name": "string",
"output_file": "string",
"skill_md": "string",
"command_ref": "string"
},
"warn": {},
"error": {},
"output_schema": {},
"end": false
}
Field |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
success |
Data | null |
no |
null |
成功した場合の結果 |
success.save_mode |
str | null |
no |
null |
保存モード |
success.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
success.from_cmd_title |
str | null |
no |
null |
元コマンドタイトル |
success.skill_name |
str | null |
no |
null |
作成したスキル名 |
success.output_file |
str | null |
no |
null |
作成したzipファイル |
success.skill_md |
str | null |
no |
null |
zip内SKILL.mdパス |
success.command_ref |
str | null |
no |
null |
zip内コマンド参照JSONパス |
warn |
dict[str, any] | list[any] | Data | str | bool | null |
no |
null |
警告がある場合の結果 |
warn.save_mode |
str | null |
no |
null |
保存モード |
warn.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
error |
dict[str, any] | list[any] | Data | str | bool | null |
no |
null |
エラーがある場合の結果 |
error.save_mode |
str | null |
no |
null |
保存モード |
error.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
output_schema |
dict[str, any] | null |
no |
null |
スキーマ情報 |
end |
bool | null |
no |
null |
終了フラグ |
skill ( install ) : cmdbox -m skill -c install <Option>
Install an Agent Skills zip archive into the data directory.
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. |
||
--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 |
120 |
Specify the maximum waiting time until the server responds. |
|||
--skill_file <skill_file> |
file |
required |
Specify the skill zip file to install. |
|||
--skill_name <skill_name> |
str |
required |
Specify destination skill name. If omitted, inferred from zip name. |
|||
--overwrite <overwrite> |
bool |
False |
True | False |
Overwrite when the target skill already exists. |
Output Schema
This command implements output_schema() returning Result model.
{
"success": {
"save_mode": "string",
"performance": [
{
"key": "string",
"value": null
}
],
"skill_name": "string",
"path": "string",
"skill_md": "string"
},
"warn": {},
"error": {},
"output_schema": {},
"end": false
}
Field |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
success |
Data | null |
no |
null |
成功した場合の結果 |
success.save_mode |
str | null |
no |
null |
保存モード |
success.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
success.skill_name |
str | null |
no |
null |
スキル名 |
success.path |
str | null |
no |
null |
インストール先パス |
success.skill_md |
str | null |
no |
null |
SKILL.mdパス |
warn |
dict[str, any] | list[any] | Data | str | bool | null |
no |
null |
警告がある場合の結果 |
warn.save_mode |
str | null |
no |
null |
保存モード |
warn.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
error |
dict[str, any] | list[any] | Data | str | bool | null |
no |
null |
エラーがある場合の結果 |
error.save_mode |
str | null |
no |
null |
保存モード |
error.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
output_schema |
dict[str, any] | null |
no |
null |
スキーマ情報 |
end |
bool | null |
no |
null |
終了フラグ |
skill ( list ) : cmdbox -m skill -c list <Option>
List installed Agent Skills.
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. |
||
--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 |
120 |
Specify the maximum waiting time until the server responds. |
|||
--kwd <kwd> |
str |
Specify the name of the skill you want to search for. The search will be performed using grep. |
Output Schema
This command implements output_schema() returning Result model.
{
"success": {
"save_mode": "string",
"performance": [
{
"key": "string",
"value": null
}
],
"data": [
{
"name": "string",
"path": "string",
"has_skill_md": false
}
]
},
"warn": {},
"error": {},
"output_schema": {},
"end": false
}
Field |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
success |
Data | null |
no |
null |
成功した場合の結果 |
success.save_mode |
str | null |
no |
null |
保存モード |
success.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
success.data |
list[SkillRecord] | null |
no |
null |
処理結果のデータ |
warn |
dict[str, any] | list[any] | Data | str | bool | null |
no |
null |
警告がある場合の結果 |
warn.save_mode |
str | null |
no |
null |
保存モード |
warn.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
error |
dict[str, any] | list[any] | Data | str | bool | null |
no |
null |
エラーがある場合の結果 |
error.save_mode |
str | null |
no |
null |
保存モード |
error.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
output_schema |
dict[str, any] | null |
no |
null |
スキーマ情報 |
end |
bool | null |
no |
null |
終了フラグ |
skill ( uninstall ) : cmdbox -m skill -c uninstall <Option>
Uninstall an installed Agent Skill.
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. |
||
--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 |
120 |
Specify the maximum waiting time until the server responds. |
|||
--skill_name <skill_name> |
str |
required |
Specify skill name to uninstall. |
Output Schema
This command implements output_schema() returning Result model.
{
"success": {
"save_mode": "string",
"performance": [
{
"key": "string",
"value": null
}
],
"data": "string"
},
"warn": {},
"error": {},
"output_schema": {},
"end": false
}
Field |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
success |
Data | null |
no |
null |
成功した場合の結果 |
success.save_mode |
str | 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.save_mode |
str | null |
no |
null |
保存モード |
warn.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
error |
dict[str, any] | list[any] | Data | str | bool | null |
no |
null |
エラーがある場合の結果 |
error.save_mode |
str | null |
no |
null |
保存モード |
error.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
output_schema |
dict[str, any] | null |
no |
null |
スキーマ情報 |
end |
bool | null |
no |
null |
終了フラグ |