Skip to content
🤷

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 attach files, images, and links

Farkitect can hold external content directly in the model through three common element types, all available in every project:

ElementHoldsUse it for
ImageAn image file (≤ 4 MB)Screenshots, photos, diagrams captured from other tools, tracing backdrops
ArtifactAny file (≤ 20 MB)A Word, Excel, or PDF deliverable referenced by the model
HyperlinkA web addressA runbook, wiki page, dashboard, or ticket

Each element holds one attachment. Attachments are stored with the model, not as loose files.

The quickest way to add an image:

  1. Copy an image to your clipboard (screenshot, or copy from a browser or file manager)
  2. On an open, editable diagram, press Ctrl+V — or right-click the canvas and choose Paste Image
  3. The image is uploaded and placed where you clicked, sized to its natural dimensions

A new Image element (“Image 1”, “Image 2”, …) is created in the diagram’s package and appears in the Explorer — it’s a real model element you can reuse on other diagrams.

  1. Create an Image element — drag the Image tool from the Palette onto the canvas (or into the Explorer)
  2. Select it and open the Properties panel
  3. In the Image section, click Upload image… and choose a file

The image fills the node body. Because an Image doesn’t contain other elements, you can drop model elements on top of it to trace over it — they stay independent.

  1. Create an Artifact element (from the Palette or Explorer)
  2. Select it and open the Properties panel
  3. In the File section, click Upload file… and choose any document

The Properties panel then shows the file name and size (e.g. report.xlsx · 240 KB). Nodes with a file attachment show a small paperclip badge.

  1. Create a Hyperlink element
  2. In the Properties panel, set the URL property
  3. On the diagram, the node shows its name with the URL beneath it as a clickable link

Clicking the link opens it in your browser (or the system browser on desktop).

With an attachment-carrying element selected, the Properties panel offers:

  • Open — see below
  • Download — save a copy to disk
  • Replace — swap in a different file
  • Remove — delete the attachment (with confirmation)

Viewers see only Open and Download.

In the desktop app, clicking Open on a file Artifact launches the file in its native application (Word, Excel, etc.). Edit it, save in that app, then switch back to Farkitect: it detects the change and asks “Save changes back to the repository?” — choose Save changes to update the attachment, or Discard to keep the stored version.

In the web app, clicking Open opens the file (or image) in your browser. There’s no automatic save-back — to update a document, edit your copy and use Replace.

Attachments travel with the model when you export a package with attachments:

  1. Right-click the package → Export Package…
  2. When asked, choose Include attachments
  3. Farkitect writes a .farki.zip archive containing the model plus every attachment

To bring it into another project, use File > Import Package… and select the .farki.zip — the images and files are restored automatically. Choosing Model only instead produces a plain .farki that keeps the model but leaves the file bytes out. See How to export a package.

  • One attachment per element — for several documents, use several Artifacts
  • Images: image/* only, up to 4 MB. Files: any type, up to 20 MB
  • Native “open and save back” is desktop-only; the web app uses download + Replace
  • Deleting an element also deletes its attachment; cloning a package copies attachments