Arquitetura como Código - Archyl Docs

Defina e sincronize sua arquitetura C4 com archyl.yaml — versionado, integrado ao CI/CD e totalmente declarativo

Exportação

O Archyl permite exportar seus diagramas de arquitetura em múltiplos formatos para uso em apresentações, documentos e ferramentas externas.

Formatos Disponíveis

PNG (Imagem Raster)

Ideal para:

  • Apresentações (PowerPoint, Google Slides)
  • Documentos (Word, Google Docs)
  • Compartilhamento via chat e e-mail
  • Posts em redes sociais

Exportações PNG mantêm total qualidade visual com resolução personalizável.

SVG (Gráficos Vetoriais)

Ideal para:

  • Ferramentas de design (Figma, Sketch, Illustrator)
  • Impressão em alta resolução
  • Incorporação na web
  • Edição adicional

Exportações SVG são escaláveis para qualquer tamanho sem perda de qualidade.

PDF (Formato de Documento)

Ideal para:

  • Impressão
  • Documentação formal
  • Fins de arquivo
  • Exportações multipágina

Exportações PDF incluem toda a estilização e podem abranger múltiplas páginas.

Como Exportar

Exportação de Nível Único

  1. Navegue até o nível C4 que deseja exportar
  2. Clique em Exportar na barra de ferramentas
  3. Selecione seu formato (PNG, SVG ou PDF)
  4. Configure as opções
  5. Clique em Exportar

Exportar Todos os Níveis

Para exportar todos os quatro níveis C4 de uma vez:

  1. Clique em Exportar na barra de ferramentas
  2. Selecione seu formato
  3. Marque Exportar todos os níveis
  4. Clique em Exportar

Isso gera arquivos separados para cada nível:

  • nome-do-projeto-contexto-do-sistema.png
  • nome-do-projeto-container.png
  • nome-do-projeto-componente.png
  • nome-do-projeto-codigo.png

Opções de Exportação

Opções de Fundo

Opção Descrição
Incluir fundo Exportar com o fundo escuro do canvas
Transparente Exportar sem fundo (adapta-se a qualquer documento)

Para documentos com temas claros, exportações transparentes funcionam melhor.

Configurações de Qualidade

Para exportações PNG:

  • Padrão: Bom para visualização em tela
  • Alta: Melhor para apresentações
  • Impressão: Ideal para impressão física

Opções de Viewport

  • Ajustar conteúdo: Exportar apenas o conteúdo do diagrama
  • Incluir margem: Adicionar margem ao redor do diagrama
  • Visualização atual: Exportar exatamente o que está visível na tela

Dicas para Melhores Resultados

Para Apresentações

  1. Exporte como PNG com alta qualidade
  2. Inclua fundo para slides escuros
  3. Use transparente para slides claros
  4. Exporte no nível C4 apropriado para seu público

Para Documentação

  1. Exporte como SVG para escalabilidade
  2. Use fundo transparente
  3. Considere exportar todos os níveis
  4. Adicione as exportações ao seu repositório de documentação

Para Impressão

  1. Exporte como PDF
  2. Escolha alta resolução
  3. Inclua fundo para impacto visual
  4. Revise a pré-visualização antes de imprimir

Para Ferramentas de Design

  1. Exporte como SVG
  2. Importe na sua ferramenta de design
  3. Os elementos permanecem editáveis
  4. Cores e estilos são preservados

Automação com API

Você pode automatizar exportações usando a API do Archyl:

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

Isso permite:

  • Integração CI/CD para documentação
  • Exportações agendadas para relatórios
  • Exportações em massa entre projetos

Exportação JSON (Portabilidade de Dados)

Para backup, migração ou compartilhamento de dados completos de arquitetura, exporte seu projeto como JSON.

O Que é Exportado

A exportação JSON inclui seu modelo C4 completo:

  • Sistemas com descrições, tecnologias, tags e posições
  • Containers aninhados dentro dos seus sistemas pai
  • Componentes aninhados dentro dos seus containers pai
  • Elementos de código incluindo métodos e propriedades
  • Relacionamentos entre todos os elementos com descrições e estilização
  • Overlays com posições, dimensões e elementos contidos

A exportação preserva o layout do seu diagrama, então projetos importados ficam exatamente como você os projetou.

Como Exportar JSON

  1. Abra o projeto que deseja exportar
  2. Clique em Exportar na barra de ferramentas
  3. Selecione o formato JSON
  4. Clique em Exportar
  5. Salve o arquivo baixado

O arquivo é nomeado {nome-do-projeto}-{data}.json e contém JSON legível.

Exportação via API

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

Isso retorna os dados completos do projeto como JSON, permitindo backups automatizados e integração CI/CD.

Importando Projetos

Você pode criar um novo projeto importando de múltiplos formatos. O Archyl suporta quatro fontes de importação:

Formato Tipo de Arquivo Ferramenta de Origem
Archyl YAML .yaml / .yml Formato nativo do Archyl
Structurizr DSL .dsl Structurizr
LikeC4 .c4 / .likec4 LikeC4
IcePanel JSON .json IcePanel

Como Importar

  1. Na sua lista de projetos, clique em Importar Projeto
  2. Selecione a aba do formato de origem (Archyl YAML, Structurizr DSL, LikeC4 ou IcePanel)
  3. Faça upload do arquivo ou cole seu conteúdo
  4. Clique em Validar para visualizar o que será criado
  5. Clique em Criar Projeto

O processo inteiro leva menos de um minuto. Todos os sistemas, containers, componentes, relacionamentos, tecnologias e tags são importados automaticamente.

Importação de Structurizr DSL

O Archyl analisa os arquivos workspace .dsl do Structurizr e extrai o modelo C4 completo: elementos person, softwareSystem, container, component, todos os relacionamentos, tecnologias e tags.

Importação de LikeC4

O Archyl é a primeira ferramenta a importar arquivos LikeC4. Tipos de elementos personalizados, hierarquias aninhadas, propriedades, tags hashtag e múltiplos blocos de modelo são todos suportados.

Importação de IcePanel JSON

A exportação JSON do IcePanel é totalmente suportada: tipos system, actor, app, store, component, campo external, modelConnections e resolução de tags.

Importação via MCP (Agentes IA)

A mesma capacidade de importação está disponível através da ferramenta MCP import_dsl para agentes de codificação IA (Claude Code, Cursor, Windsurf).

Importar em Projetos Existentes

Você também pode importar em um projeto existente. Elementos que já existem são atualizados; novos elementos são criados.

Próximos Passos