코드형 아키텍처 - Archyl Docs

archyl.yaml로 C4 아키텍처를 정의하고 동기화 — 버전 관리, CI/CD 지원, 완전한 선언형

내보내기

Archyl을 사용하면 프레젠테이션, 문서 및 외부 도구에서 사용할 수 있도록 다양한 형식으로 아키텍처 다이어그램을 내보낼 수 있습니다.

사용 가능한 형식

PNG (래스터 이미지)

적합한 용도:

  • 프레젠테이션 (PowerPoint, Google Slides)
  • 문서 (Word, Google Docs)
  • 채팅 및 이메일 공유
  • 소셜 미디어 게시물

PNG 내보내기는 사용자 정의 가능한 해상도로 완전한 시각적 품질을 유지합니다.

SVG (벡터 그래픽)

적합한 용도:

  • 디자인 도구 (Figma, Sketch, Illustrator)
  • 고해상도 인쇄
  • 웹 임베딩
  • 추가 편집

SVG 내보내기는 품질 손실 없이 어떤 크기로도 확장 가능합니다.

PDF (문서 형식)

적합한 용도:

  • 인쇄
  • 공식 문서
  • 보관 목적
  • 다중 페이지 내보내기

PDF 내보내기는 모든 스타일을 포함하며 여러 페이지에 걸칠 수 있습니다.

내보내기 방법

단일 레벨 내보내기

  1. 내보낼 C4 레벨로 이동합니다
  2. 툴바에서 내보내기를 클릭합니다
  3. 형식을 선택합니다 (PNG, SVG 또는 PDF)
  4. 옵션을 구성합니다
  5. 내보내기를 클릭합니다

전체 레벨 내보내기

네 가지 C4 레벨을 한 번에 내보내려면:

  1. 툴바에서 내보내기를 클릭합니다
  2. 형식을 선택합니다
  3. 모든 레벨 내보내기를 체크합니다
  4. 내보내기를 클릭합니다

각 레벨에 대해 별도의 파일이 생성됩니다:

  • project-name-system-context.png
  • project-name-container.png
  • project-name-component.png
  • project-name-code.png

내보내기 옵션

배경 옵션

옵션 설명
배경 포함 어두운 캔버스 배경과 함께 내보내기
투명 배경 없이 내보내기 (모든 문서에 적응)

밝은 테마의 문서에는 투명 내보내기가 가장 적합합니다.

품질 설정

PNG 내보내기의 경우:

  • 표준: 화면 보기에 적합
  • 고화질: 프레젠테이션에 적합
  • 인쇄: 물리적 인쇄에 최적

뷰포트 옵션

  • 콘텐츠 맞춤: 다이어그램 콘텐츠만 내보내기
  • 여백 포함: 다이어그램 주변에 여백 추가
  • 현재 뷰: 화면에 보이는 그대로 내보내기

최상의 결과를 위한 팁

프레젠테이션용

  1. 고화질 PNG로 내보내기
  2. 어두운 슬라이드에는 배경 포함
  3. 밝은 슬라이드에는 투명 배경 사용
  4. 대상에 맞는 적절한 C4 레벨로 내보내기

문서용

  1. 확장성을 위해 SVG로 내보내기
  2. 투명 배경 사용
  3. 모든 레벨 내보내기 고려
  4. 문서 리포지토리에 내보내기 파일 추가

인쇄용

  1. PDF로 내보내기
  2. 고해상도 선택
  3. 시각적 효과를 위해 배경 포함
  4. 인쇄 전 미리보기 확인

디자인 도구용

  1. SVG로 내보내기
  2. 디자인 도구에 가져오기
  3. 요소가 편집 가능한 상태로 유지
  4. 색상과 스타일이 보존됨

API를 통한 자동화

Archyl API를 사용하여 내보내기를 자동화할 수 있습니다:

curl -X GET \
  -H "X-API-Key: your-api-key" \
  "https://api.archyl.com/api/v1/projects/{projectId}/export?format=png&level=system-context"

이를 통해 다음이 가능합니다:

  • 문서화를 위한 CI/CD 통합
  • 보고용 예약된 내보내기
  • 프로젝트 전반의 일괄 내보내기

JSON 내보내기 (데이터 이동성)

백업, 마이그레이션 또는 완전한 아키텍처 데이터 공유를 위해 프로젝트를 JSON으로 내보냅니다.

내보내기에 포함되는 것

JSON 내보내기에는 완전한 C4 모델이 포함됩니다:

  • 시스템 (설명, 기술, 태그 및 위치 포함)
  • 컨테이너 (상위 시스템 내에 중첩)
  • 컴포넌트 (상위 컨테이너 내에 중첩)
  • 코드 요소 (메서드 및 속성 포함)
  • 관계 (모든 요소 간, 설명 및 스타일 포함)
  • 오버레이 (위치, 크기 및 포함된 요소)

내보내기는 다이어그램 레이아웃을 보존하여 가져온 프로젝트가 설계한 그대로 표시됩니다.

JSON 내보내기 방법

  1. 내보낼 프로젝트를 엽니다
  2. 툴바에서 내보내기를 클릭합니다
  3. JSON 형식을 선택합니다
  4. 내보내기를 클릭합니다
  5. 다운로드된 파일을 저장합니다

파일 이름은 {project-name}-{date}.json이며 사람이 읽을 수 있는 JSON을 포함합니다.

API를 통한 내보내기

curl -X GET \
  -H "X-API-Key: your-api-key" \
  "https://api.archyl.com/api/v1/projects/{projectId}/export"

완전한 프로젝트 데이터를 JSON으로 반환하여 자동 백업 및 CI/CD 통합이 가능합니다.

프로젝트 가져오기

여러 형식에서 가져와 새 프로젝트를 만들 수 있습니다. Archyl은 네 가지 가져오기 소스를 지원합니다:

형식 파일 유형 소스 도구
Archyl YAML .yaml / .yml Archyl 네이티브 형식
Structurizr DSL .dsl Structurizr
LikeC4 .c4 / .likec4 LikeC4
IcePanel JSON .json IcePanel

가져오기 방법

  1. 프로젝트 목록에서 프로젝트 가져오기를 클릭합니다
  2. 소스 형식 탭을 선택합니다 (Archyl YAML, Structurizr DSL, LikeC4 또는 IcePanel)
  3. 파일을 업로드하거나 내용을 붙여넣기합니다
  4. 검증을 클릭하여 생성될 내용을 미리봅니다
  5. 프로젝트 만들기를 클릭합니다

전체 과정은 1분도 걸리지 않습니다. 모든 시스템, 컨테이너, 컴포넌트, 관계, 기술 및 태그가 자동으로 가져와집니다.

Structurizr DSL 가져오기

Archyl은 Structurizr의 .dsl 워크스페이스 파일을 파싱하여 전체 C4 모델을 추출합니다: person, softwareSystem, container, component 요소, 모든 관계, 기술 및 태그.

LikeC4 가져오기

Archyl은 LikeC4 파일을 가져오는 최초의 도구입니다. 사용자 정의 요소 유형, 중첩 계층 구조, 속성, 해시태그 태그 및 다중 모델 블록이 모두 지원됩니다.

IcePanel JSON 가져오기

IcePanel의 JSON 내보내기가 완전히 지원됩니다: system, actor, app, store, component 유형, external 필드, modelConnections 및 태그 해석.

MCP를 통한 가져오기 (AI 에이전트)

동일한 가져오기 기능은 AI 코딩 에이전트(Claude Code, Cursor, Windsurf)를 위한 MCP 도구 import_dsl을 통해서도 사용할 수 있습니다.

기존 프로젝트로 가져오기

기존 프로젝트에 가져올 수도 있습니다. 이미 존재하는 요소는 업데이트되고, 새 요소는 생성됩니다.

다음 단계