Toast-cli follows a plugin-based architecture that makes it easy to extend and maintain.
toast or python -m toasttoast/__init__.py discovers plugins; helpers.py supplies help and version output.am · cdw · ctx · dot · env · git · prompt · region · ssmutils.py: command execution, secret masking, atomic file writes.storage.py: parallel S3 + SSM reads for dot and prompt; writes to S3.toast-cli/
├── setup.py # Package setup script
├── pyproject.toml # Build system requirements
├── MANIFEST.in # Additional files to include
├── VERSION # Version information
├── README.md # Project documentation
├── ARCHITECTURE.md # Architecture documentation
├── LICENSE # License information
├── docs/ # Documentation website files
│ ├── CNAME # Custom domain configuration
│ ├── favicon.ico # Website favicon
│ ├── index.html # Main documentation page
│ ├── css/ # Stylesheet files
│ └── js/ # JavaScript files
└── toast/ # Main package
├── __init__.py # Package initialization and CLI entry point
├── __main__.py # Entry point for running as a module
├── helpers.py # Helper functions and custom UI elements
└── plugins/ # Plugin modules
├── __init__.py
├── base_plugin.py
├── am_plugin.py
├── cdw_plugin.py
├── ctx_plugin.py
├── dot_plugin.py
├── env_plugin.py
├── git_plugin.py
├── prompt_plugin.py
├── region_plugin.py
├── ssm_plugin.py
├── storage.py
└── utils.pyTo add a new plugin:
toast/plugins directoryBasePluginexecute and optionally get_arguments)name and help class variablesThe plugin will be automatically discovered and loaded when the application starts.
from toast import ui
from toast.plugins.base_plugin import BasePlugin
import click
class MyPlugin(BasePlugin):
name = "mycommand"
help = "Description of my command"
@classmethod
def get_arguments(cls, func):
# Optional: Define command arguments
func = click.option("--option", "-o", help="An option for my command")(func)
return func
@classmethod
def execute(cls, **kwargs):
# Command implementation
option = kwargs.get("option")
if option:
ui.result(f"Executing with option: {option}")
else:
ui.result("My custom command execution")