Config Structures
Configuration
ScopedExtensionConfig
version— Version constraint string (e.g., ">=2.0.0", "^1.0").settings— Settings passed to the extension at runtime.
GitDeployConfig
remotebranchpost_pull— Commands to run after git pull (e.g., "composer install", "npm run build")tag_pattern— Pull a specific tag instead of branch HEAD (e.g., "v{{version}}")
TestConfig
namedescriptiontagsextensions
HomeboyConfig
defaultsupdate_check— Enable automatic update check on startup (default: true). Disable withhomeboy config set /update_check falseor set HOMEBOY_NO_UPDATE_CHECK=1.
InstallMethodsConfig
homebrewcargosourcebinary
InstallMethodConfig
path_patternsupgrade_commandlist_command
VersionCandidateConfig
filepattern
DeployConfig
scp_flagsartifact_prefixdefault_ssh_port
PermissionsConfig
localremote
ProvidesConfig
file_extensions— File extensions this extension can process (e.g., ["php", "inc"]).capabilities— Capabilities this extension supports (e.g., ["fingerprint", "refactor"]).
ScriptsConfig
fingerprint— Script that extracts structural fingerprints from source files. Receives file content on stdin, outputs FileFingerprint JSON on stdout.refactor— Script that applies refactoring edits to source files. Receives edit instructions on stdin, outputs transformed content on stdout.
RequirementsConfig
extensionscomponents
DatabaseConfig
cli
DatabaseCliConfig
tables_commanddescribe_commandquery_command
CliHelpConfig
project_id_helpargs_helpexamples
CliConfig
tooldisplay_namecommand_templatedefault_cli_pathworking_dir_templatesettings_flagshelp
DiscoveryConfig
find_commandbase_path_transformdisplay_name_command
VersionPatternConfig
extensionpattern
SinceTagConfig
extensions— File extensions to scan (e.g., [".php"]).placeholder_pattern— Regex pattern matching placeholder versions in@sincetags. Default:0.0.0|NEXT|TBD|TODO|UNRELEASED|x.x.x
BuildConfig
artifact_extensionsscript_namescommand_templateextension_scriptpre_build_scriptartifact_pattern— Default artifact path pattern with template support. Supports: {component_id}, {local_path}cleanup_paths— Paths to clean up after successful deploy (e.g., node_modules, vendor, target)
LintConfig
extension_script
RuntimeConfig
runtime_type— Desktop app runtime type (python/shell/cli). CLI ignores this field.run_command— Shell command to execute when running the extension. Template variables: {{entrypoint}}, {{args}}, {{extensionPath}}, plus project context vars.setup_command— Shell command to set up the extension (e.g., create venv, install deps).ready_check— Shell command to check if extension is ready. Exit 0 = ready.env— Environment variables to set when running the extension.entrypoint— Entry point file (used in template substitution).args— Default args template (used in template substitution).default_site— Default site for this extension (used by some CLI extensions).dependencies— Desktop app: Python dependencies to install.playwright_browsers— Desktop app: Playwright browsers to install.
InputConfig
idinput_typelabelplaceholderdefaultminmaxoptionsarg
OutputConfig
schemadisplayselectable
ActionConfig
idlabelaction_typeendpointmethodrequires_authpayloadcommandbuiltin— Builtin action type (Desktop app only). CLI parses but does not execute.column— Column identifier for copy-column builtin action.
SettingConfig
idsetting_typelabelplaceholderdefault
RemoteFileConfig
pinned_files
RemoteLogConfig
pinned_logs
ApiConfig
enabledbase_urlauth
AuthConfig
headervariablesloginrefresh
AuthFlowConfig
endpointmethodbodystore
ToolsConfig
bandcamp_scrapernewsletter
BandcampScraperConfig
default_tag
NewsletterConfig
sendy_list_id
Manifests
ExtensionManifest
idnameversionprovidesscriptsicondescriptionauthorhomepagesource_urldeployauditexecutableplatformclibuildlinttestactionshookssettingsrequiresextraextension_path