Plugin CLI Commands

The Synapse SDK provides CLI commands for plugin development and execution.

synapse plugin run

Run a plugin action with various execution modes.

Usage

synapse plugin run <action> [OPTIONS]

Arguments

Argument	Description
action	Action to run (e.g., test, train, deploy, infer)

Options

Option	Short	Description
--plugin	-p	Plugin code. Auto-detects from config.yaml if not provided
--path		Plugin directory (default: current)
--params		JSON parameters to pass to the action
--mode	-m	Executor mode: local, task, job, or remote
--ray-address		Ray cluster address (for task/job modes)
--gpus		Number of GPUs to request
--cpus		Number of CPUs to request
--lang	-l	Language for i18n log messages (ISO 639-1, e.g., 'en', 'ko')
--debug/--no-debug		Debug mode (default: enabled)
--debug-sdk		Bundle local SDK with upload (for SDK development)

Executor Modes

Mode	Description
local	In-process execution (best for debugging)
task	Ray Actor execution (no log streaming)
job	Ray Jobs API with log streaming (recommended for remote)
remote	Run via Synapse backend API (requires auth)

Examples

# Basic execution
synapse plugin run test
synapse plugin run test --mode local

# With GPU allocation
synapse plugin run test --mode task --gpus 1

# With parameters
synapse plugin run train --mode job --params '{"epochs": 10}'

# With language selection (i18n)
synapse plugin run train --lang=ko --params '{"epochs": 10}'
synapse plugin run train -l en  # Short form

# Language with different execution modes
synapse plugin run train --mode local --lang=ko
synapse plugin run train --mode task --lang=ko
synapse plugin run train --mode job --lang=ko

# Remote execution
synapse plugin run deploy --mode remote

synapse plugin publish

Publish a plugin release to Synapse.

Usage

synapse plugin publish [OPTIONS]

Options

Option	Short	Description
--path	-p	Plugin directory (default: current)
--config	-c	Config file path
--host		Synapse API host
--token	-t	Access token
--dry-run		Preview without uploading
--debug		Debug mode (bypasses backend validation)
--yes	-y	Skip confirmation

Examples

synapse plugin publish
synapse plugin publish -p ./my-plugin --dry-run

synapse plugin create

Create a new plugin from template.

Usage

synapse plugin create [OPTIONS]

Options

Option	Short	Description
--path	-p	Output directory (default: current)
--name	-n	Plugin name
--code		Plugin code (slug)
--category	-c	Plugin category
--yes	-y	Skip confirmation

Examples

synapse plugin create
synapse plugin create --name "My Plugin" --category neural_net

synapse plugin update-config

Auto-discover actions and sync to config.yaml.

Usage

synapse plugin update-config [OPTIONS]

Options

Option	Short	Description
--path	-p	Plugin directory (default: current)
--config	-c	Config file path

Examples

synapse plugin update-config
synapse plugin update-config -p ./my-plugin

synapse plugin job get

Get job details.

Usage

synapse plugin job get <job_id> [OPTIONS]

Options

Option	Short	Description
--host		Synapse API host
--token	-t	Access token

Examples

synapse plugin job get 123

synapse plugin job logs

Get job logs.

Usage

synapse plugin job logs <job_id> [OPTIONS]

Options

Option	Short	Description
--follow	-f	Follow log output (stream)
--host		Synapse API host
--token	-t	Access token

Examples

synapse plugin job logs 123
synapse plugin job logs 123 -f