빠른 시작 가이드
Synapse SDK를 몇 분 안에 시작하세요.
사전 요구 사항
CLI 명령을 실행하기 전에 환경이 설정되어 있어야 합니다. 자세한 내용은 설치 및 설정을 참조하세요.
# 방법 1: uv run 사용
uv run synapse --help
# 방법 2: 가상 환경 먼저 활성화
source .venv/bin/activate
synapse --help
CLI 개요
사용 가능한 모든 명령 보기:
synapse --help
명령 그룹:
- plugin: 플러그인 생성, 테스트 및 배포
- agent: 에이전트 연결 설정
- mcp: AI 어시스턴트 통합을 위한 MCP 서버
단독 명령:
- login: Synapse 백엔드 인증
빠른 명령
# Synapse 백엔드 로그인
synapse login
# 원격 실행을 위한 에이전트 선택
synapse agent select
# 새 플러그인 생성
synapse plugin create
첫 번째 플러그인 만들기
이 섹션에서는 두 수를 더하는 간단한 계산기 플러그인을 만드는 과정을 안내합니다.
Step 1: 플러그인 생성
create 명령을 실행하세요:
synapse plugin create
대화형 프롬프트가 표시됩니다. 다음 단계를 따르세요:
1. 플러그인 카테고리 선택 - Custom을 선택하세요 (학습에 가장 간단한 옵션):
? Select plugin category: (Use arrow keys)
Neural Net Train and deploy ML models
Export Data format conversion
Upload External data import
Smart Tool Interactive annotation helpers
Post Annotation Process annotations after labeling
Pre Annotation Auto-generate initial annotations
Data Validation Pre-annotation data checks
» Custom Custom plugin type
2. 플러그인 정보 입력:
? Plugin name: Add Calculator
? Plugin code: (add-calculator) # Enter를 눌러 기본값 수락
? Version: (0.1.0) # Enter를 눌러 기본값 수락
? Description: (Add Calculator plugin)
3. 검토 및 확인 - 미리보기가 표시됩니다. Y를 입력하여 생성:
╭─────────── Plugin Info ───────────╮
│ Name Add Calculator │
│ Code add-calculator │
│ Version 0.1.0 │
│ Category Custom │
╰───────────────────────────────────╯
? Create plugin? (Y/n)
확인 후 synapse-add-calculator-plugin/ 디렉토리가 생성됩니다.
Step 2: 로직 구현
플러그인 디렉토리로 이동하여 메인 액션 파일을 수정하세요:
cd synapse-add-calculator-plugin
plugin/main.py를 열어 MainParams 클래스와 execute 메서드를 수정하세요:
"""Add Calculator의 메인 액션."""
from __future__ import annotations
from pydantic import BaseModel
from synapse_sdk.plugins.action import BaseAction
class MainParams(BaseModel):
"""메인 액션 파라미터."""
a: int = 0
b: int = 0
class MainAction(BaseAction[MainParams]):
"""메인 액션 구현."""
def execute(self) -> dict:
"""메인 액션을 실행합니다.
Returns:
액션 결과.
"""
result = self.params.a + self.params.b
return {
"sum": result,
"expression": f"{self.params.a} + {self.params.b} = {result}",
}
Step 3: 로컬 테스트
샘플 파라미터로 플러그인을 테스트하세요:
synapse plugin run main --mode local --params '{"a": 5, "b": 3}'
main이란?main은 config.yaml에 정의된 액션 이름입니다. 각 플러그인은 여러 액션을 가질 수 있습니다:
# config.yaml
actions:
main: # ← 액션 이름
entrypoint: plugin.main:MainAction
method: task
예를 들어, neural_net 플러그인은 train과 inference 액션을 가질 수 있으며, synapse plugin run train 또는 synapse plugin run inference로 실행합니다.
예상 출력:
{"sum": 8, "expression": "5 + 3 = 8"}
Step 4: 배포 (선택사항)
완성되면 Synapse 백엔드에 배포하세요:
synapse plugin publish
다음 단계
첫 번째 플러그인을 만들었으니 다음을 시도해보세요:
- 입력값 유효성 검사 추가
- 더 많은 연산 지원 (빼기, 곱하기, 나누기)
Neural Net이나Export같은 다른 플러그인 카테고리 탐색