GeneratedSDK 0.10.1
The yourbot CLI
Every subcommand and flag of the yourbot command-line tool.
Installed with pip install yourbot-sdk. Run yourbot <command> --help for the same text in your terminal.
yourbot init
interactive wizard for first-time plugin setup (prompts instead of flags)
No arguments.
yourbot new
scaffold a new plugin directory
| Argument | Signification |
|---|---|
plugin_id | lowercase id (3-32 chars, letters/digits/underscore, starts with letter) |
--target, -t | directory to create (default: ./<plugin_id>) |
--template | starter template (default: basic). Run `yourbot new --list-templates` to see what each one does. Par défaut basic |
--list-templates | print the catalog of available templates and exit |
yourbot dev
run plugin locally against a mock host
| Argument | Signification |
|---|---|
--path, -p | plugin directory (default: cwd) |
--watch, -w | reload on file changes |
yourbot validate
run pre-submit checks locally (the same ones the platform runs)
| Argument | Signification |
|---|---|
--path, -p | plugin directory (default: cwd) |
--id | override the plugin_id for the cap-mismatch check (default: read from manifest.json, then directory name) |
--version | override the version for the version-mismatch check (default: read from manifest.json) |
yourbot doctor
pre-flight diagnostic: SDK install, manifest, capabilities, tests, env
| Argument | Signification |
|---|---|
--path, -p | plugin directory (default: cwd) |
YourBot docs
Reference tables are generated from the code that is running.
Ask in Discord
Suggest a correction