Documentación / Developers / Referencia / The yourbot CLI
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

ArgumentSignificado
plugin_idlowercase id (3-32 chars, letters/digits/underscore, starts with letter)
--target, -tdirectory to create (default: ./<plugin_id>)
--templatestarter template (default: basic). Run `yourbot new --list-templates` to see what each one does. Predeterminado basic
--list-templatesprint the catalog of available templates and exit

yourbot dev

run plugin locally against a mock host

ArgumentSignificado
--path, -pplugin directory (default: cwd)
--watch, -wreload on file changes

yourbot validate

run pre-submit checks locally (the same ones the platform runs)

ArgumentSignificado
--path, -pplugin directory (default: cwd)
--idoverride the plugin_id for the cap-mismatch check (default: read from manifest.json, then directory name)
--versionoverride the version for the version-mismatch check (default: read from manifest.json)

yourbot doctor

pre-flight diagnostic: SDK install, manifest, capabilities, tests, env

ArgumentSignificado
--path, -pplugin directory (default: cwd)
YourBot docs Reference tables are generated from the code that is running. Ask in Discord Suggest a correction