Skip to content
Farkitect
🤷

Forgive us! These docs are a work in progress. Some pages may be incomplete or describe features that aren't quite finished yet. Farkitect is in early development and we don't recommend using it for real work just yet. Feel free to explore — just be aware that things are still being built.

How to export a package

Export a single package or package tree

Section titled “Export a single package or package tree”
  1. Right-click the package you want to export in the Explorer
  2. Select Export Package… (or use File > Export Package… with the package selected)
  3. If the package contains attachments, a dialog asks how to export them (see below)
  4. Choose a location and filename
  5. The package and all its descendants (sub-packages, elements, relationships, diagrams, catalogs, board views, property values) are written to the file

The exported file is self-contained — it includes everything needed to recreate the package tree in another project.

Exporting attachments

Section titled “Exporting attachments”

If any element in the package carries an attachment — an Image, a document Artifact, or another file — Farkitect asks how to handle it:

ChoiceResult
Include attachmentsA .farki.zip archive containing the model plus every attachment payload
Model onlyA plain .farki file with the attachment descriptors stripped (the model still references them, but the file bytes are not included)
CancelNothing is exported

If the package has no attachments, no dialog appears — it exports straight to a .farki file.

See How to attach files, images, and links for what attachments are and how the .farki.zip archive is structured.

What’s included

Section titled “What’s included”

The export captures:

  • The package and all nested sub-packages
  • All elements and relationships within the package tree
  • All diagrams, catalogs, and board views
  • All property values
  • Notation and constraint definitions (for M2 packages)
  • Package import declarations
  • Attachment payloads (when exported as .farki.zip)

Exporting a metamodel

Section titled “Exporting a metamodel”

An M2 metamodel is exported from its root package — right-click the top package of the metamodel and choose Export Package…. The metamodel’s structural sub-packages (Element Types, Relationship Types, Enumerations, Views) are not exported individually; they travel with the root.

Tips

Section titled “Tips”
  • Export an M2 metamodel package to share your custom modeling language with colleagues
  • Export an M1 model package to create a backup or transfer it to another project
  • The .farki format is human-readable JSON — you can inspect it in any text editor
  • A .farki.zip is a standard Zip archive; unzip it to find model.farki alongside a files/ folder of attachments
  • .farki files can be version-controlled with Git, shared via email, or published to the Farketplace
  • Deleting a project, organisation, or account automatically exports a .farki backup first — you don’t have to remember to do it manually