コードとしてのアーキテクチャ - Archyl Docs

archyl.yamlでC4アーキテクチャを定義・同期 — バージョン管理、CI/CD対応、完全な宣言型

エクスポート

Archylでは、プレゼンテーション、ドキュメント、外部ツールで使用するために、アーキテクチャダイアグラムを複数のフォーマットでエクスポートできます。

利用可能なフォーマット

PNG(ラスター画像)

最適な用途:

  • プレゼンテーション(PowerPoint、Google Slides)
  • ドキュメント(Word、Google Docs)
  • チャットやメールでの共有
  • ソーシャルメディア投稿

PNGエクスポートはカスタマイズ可能な解像度で完全な画質を維持します。

SVG(ベクターグラフィックス)

最適な用途:

  • デザインツール(Figma、Sketch、Illustrator)
  • 高解像度印刷
  • Web埋め込み
  • さらなる編集

SVGエクスポートは品質を損なうことなく任意のサイズに拡大縮小できます。

PDF(ドキュメントフォーマット)

最適な用途:

  • 印刷
  • 正式なドキュメント
  • アーカイブ目的
  • 複数ページのエクスポート

PDFエクスポートはすべてのスタイリングを含み、複数ページにまたがることができます。

エクスポート方法

単一レベルのエクスポート

  1. エクスポートしたいC4レベルに移動
  2. ツールバーのエクスポートをクリック
  3. フォーマットを選択(PNG、SVG、またはPDF)
  4. オプションを設定
  5. エクスポートをクリック

全レベルのエクスポート

4つの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は4つのインポートソースをサポートしています:

フォーマット ファイルタイプ ソースツール
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エージェント)

同じインポート機能はMCPツールimport_dslを通じてAIコーディングエージェント(Claude Code、Cursor、Windsurf)でも利用可能です。

既存プロジェクトへのインポート

既存のプロジェクトにインポートすることもできます。既に存在する要素は更新され、新しい要素は作成されます。

次のステップ