7b58ad5fa5
- list, list --all, list --format=json and an --ansi styled list (D-13, D-16)
- admin:token:create help and a passthrough help; help <cmd> equals --help (D-14)
- error blocks: hint with {bin}, unknown command, -v chain on stderr (D-18)
- CheckDocs gaps in order and sorted; the version header and BuildVersion
- goldens render with color detection cleared; -update rewrites them
274 lines
6.9 KiB
Plaintext
274 lines
6.9 KiB
Plaintext
{
|
|
"application": {
|
|
"name": "acme",
|
|
"version": "v1.4.0",
|
|
"framework": "v0.3.2"
|
|
},
|
|
"global_options": [
|
|
{
|
|
"name": "help",
|
|
"shorthand": "h",
|
|
"description": "Display help for the given command",
|
|
"default": "",
|
|
"bare": true,
|
|
"repeatable": false
|
|
},
|
|
{
|
|
"name": "quiet",
|
|
"shorthand": "q",
|
|
"description": "Do not output any message",
|
|
"default": "",
|
|
"bare": true,
|
|
"repeatable": false
|
|
},
|
|
{
|
|
"name": "verbose",
|
|
"shorthand": "v",
|
|
"description": "Increase verbosity (-v, -vv or -vvv)",
|
|
"default": "",
|
|
"bare": true,
|
|
"repeatable": true
|
|
},
|
|
{
|
|
"name": "ansi",
|
|
"shorthand": "",
|
|
"description": "Force ANSI output",
|
|
"default": "",
|
|
"bare": true,
|
|
"repeatable": false
|
|
},
|
|
{
|
|
"name": "no-ansi",
|
|
"shorthand": "",
|
|
"description": "Disable ANSI output",
|
|
"default": "",
|
|
"bare": true,
|
|
"repeatable": false
|
|
},
|
|
{
|
|
"name": "no-interaction",
|
|
"shorthand": "n",
|
|
"description": "Do not ask any interactive question",
|
|
"default": "",
|
|
"bare": true,
|
|
"repeatable": false
|
|
},
|
|
{
|
|
"name": "env",
|
|
"shorthand": "",
|
|
"description": "The environment the command runs under",
|
|
"default": "",
|
|
"bare": false,
|
|
"repeatable": false
|
|
}
|
|
],
|
|
"commands": [
|
|
{
|
|
"name": "acme:secret",
|
|
"description": "Rotate the internal signing secret",
|
|
"long": "",
|
|
"usage": "acme:secret [options]",
|
|
"hidden": true,
|
|
"passthrough": false,
|
|
"arguments": [],
|
|
"options": [],
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "admin:create",
|
|
"description": "Create a backend administrator",
|
|
"long": "",
|
|
"usage": "admin:create [options]",
|
|
"hidden": false,
|
|
"passthrough": false,
|
|
"arguments": [],
|
|
"options": [],
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "admin:token:create",
|
|
"description": "Create a personal API token for a backend admin",
|
|
"long": "Creates a token for the admin with the given login and prints it once.\nStore it in the client right away; it cannot be shown again.",
|
|
"usage": "admin:token:create \u003clogin\u003e [options]",
|
|
"hidden": false,
|
|
"passthrough": false,
|
|
"arguments": [
|
|
{
|
|
"name": "login",
|
|
"description": "The admin's login",
|
|
"required": true
|
|
}
|
|
],
|
|
"options": [
|
|
{
|
|
"name": "scopes",
|
|
"shorthand": "",
|
|
"description": "Comma-separated scopes",
|
|
"default": "*",
|
|
"bare": false,
|
|
"repeatable": false
|
|
},
|
|
{
|
|
"name": "expires",
|
|
"shorthand": "",
|
|
"description": "Days until expiry",
|
|
"default": "90",
|
|
"bare": false,
|
|
"repeatable": false
|
|
},
|
|
{
|
|
"name": "json",
|
|
"shorthand": "",
|
|
"description": "Print the token as JSON",
|
|
"default": "",
|
|
"bare": true,
|
|
"repeatable": false
|
|
},
|
|
{
|
|
"name": "tag",
|
|
"shorthand": "t",
|
|
"description": "A tag for the token",
|
|
"default": "",
|
|
"bare": false,
|
|
"repeatable": true
|
|
}
|
|
],
|
|
"examples": [
|
|
{
|
|
"command": "admin:token:create jane --scopes=journal.*",
|
|
"description": "Token for the MCP server, journal only"
|
|
},
|
|
{
|
|
"command": "admin:token:create jane --json",
|
|
"description": "Script-friendly output"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "help",
|
|
"description": "Display help for a command",
|
|
"long": "Prints the description, usage, arguments, options, long help and examples of a command. Without a command name it prints the command list.",
|
|
"usage": "help [command_name] [options]",
|
|
"hidden": false,
|
|
"passthrough": false,
|
|
"arguments": [
|
|
{
|
|
"name": "command_name",
|
|
"description": "The command name",
|
|
"required": false
|
|
}
|
|
],
|
|
"options": [],
|
|
"examples": [
|
|
{
|
|
"command": "help migrate",
|
|
"description": "Help for the migrate command"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "list",
|
|
"description": "List commands",
|
|
"long": "Prints the commands grouped by namespace. --all includes hidden commands; --format=json prints every command with its arguments, options and examples.",
|
|
"usage": "list [options]",
|
|
"hidden": false,
|
|
"passthrough": false,
|
|
"arguments": [],
|
|
"options": [
|
|
{
|
|
"name": "all",
|
|
"shorthand": "",
|
|
"description": "Show hidden commands too",
|
|
"default": "",
|
|
"bare": true,
|
|
"repeatable": false
|
|
},
|
|
{
|
|
"name": "format",
|
|
"shorthand": "",
|
|
"description": "The output format (txt or json)",
|
|
"default": "txt",
|
|
"bare": false,
|
|
"repeatable": false
|
|
}
|
|
],
|
|
"examples": [
|
|
{
|
|
"command": "list --all",
|
|
"description": "Every command, hidden ones included"
|
|
},
|
|
{
|
|
"command": "list --format=json",
|
|
"description": "The catalog for scripts and agents"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "make:command",
|
|
"description": "Create a new console command",
|
|
"long": "",
|
|
"usage": "make:command [options]",
|
|
"hidden": false,
|
|
"passthrough": false,
|
|
"arguments": [],
|
|
"options": [],
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "make:model",
|
|
"description": "Create a new model and migration",
|
|
"long": "",
|
|
"usage": "make:model [options]",
|
|
"hidden": false,
|
|
"passthrough": false,
|
|
"arguments": [],
|
|
"options": [],
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "migrate",
|
|
"description": "Run the database migrations",
|
|
"long": "",
|
|
"usage": "migrate [options]",
|
|
"hidden": false,
|
|
"passthrough": false,
|
|
"arguments": [],
|
|
"options": [],
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "serve",
|
|
"description": "Serve the application",
|
|
"long": "",
|
|
"usage": "serve [options]",
|
|
"hidden": false,
|
|
"passthrough": false,
|
|
"arguments": [],
|
|
"options": [],
|
|
"examples": []
|
|
},
|
|
{
|
|
"name": "tool:exec",
|
|
"description": "Run the bundled tool with its own arguments",
|
|
"long": "Everything after the command name reaches the tool unchanged, global flags included.",
|
|
"usage": "tool:exec [args] [options] [--] \u003cargs...\u003e",
|
|
"hidden": false,
|
|
"passthrough": true,
|
|
"arguments": [
|
|
{
|
|
"name": "args",
|
|
"description": "The tool's arguments",
|
|
"required": false
|
|
}
|
|
],
|
|
"options": [],
|
|
"examples": [
|
|
{
|
|
"command": "tool:exec --version",
|
|
"description": "The tool's own version"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|