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.

Working with Projects

In this tutorial, you’ll create a project, understand how projects isolate model data within an organisation, and learn to switch between projects.

Prerequisites: You’ve completed Setting Up Your Organisation.

1. What is a Project?

Section titled “1. What is a Project?”

A project is a modelling workspace that contains all the packages, elements, relationships, diagrams, and catalogs for a particular effort. Projects live inside an organisation and provide data isolation — the models in one project are separate from the models in another.

Typical uses for projects:

  • One project per modelling initiative (e.g., “Application Landscape 2026”)
  • One project per client or engagement
  • A sandbox project for experimentation
  • A project per metamodel under development

2. Create a Project

Section titled “2. Create a Project”

You’ve already created projects in earlier tutorials via File > New Project…. The three options are:

  • From Asset — start from a Farketplace starter with a metamodel pre-loaded
  • From File — import a project-scope .farki file
  • Empty — a blank project with only M3 MOF Core

Each project starts with its own M3 MOF Core package and M2 Common package. Any additional metamodels or models come from the starter asset, imported file, or your own creation.

3. Project Scope

Section titled “3. Project Scope”

Every element, relationship, diagram, and catalog belongs to exactly one project. When you switch projects, the Explorer, Canvas, and Palette all update to show that project’s contents.

System packages (M3 MOF Core, M2 Common, and built-in M2 metamodels) are shared — they appear in every project and are read-only.

Your M1 and custom M2 packages are project-scoped — they exist only in the project where you created or imported them.

4. Switch Between Projects

Section titled “4. Switch Between Projects”

If you have multiple projects:

  1. Look for the project switcher in the toolbar or header area
  2. Click it to see your available projects
  3. Select the project you want to switch to

The entire workspace updates — Explorer, Canvas, Palette, and Properties all show the new project’s contents.

Layout persistence

Section titled “Layout persistence”

Your panel layout (which panels are open, their positions and sizes) is saved per project. When you switch back to a project, the layout is restored exactly as you left it.

Dirty diagram guard

Section titled “Dirty diagram guard”

If you have unsaved diagram changes when switching projects, you’ll be prompted to save or discard them before the switch happens. This prevents accidental loss of layout work.

5. Default Project

Section titled “5. Default Project”

Every organisation has a default project that opens automatically when you launch the web app. If you only have one project, it’s the default. If you have multiple, you can set which one opens first.

What You’ve Learned

Section titled “What You’ve Learned”
  • What projects are and how they provide data isolation
  • The three ways to create a project (asset, file, empty)
  • How project scope works — your models are project-specific, system packages are shared
  • How to switch between projects with the project switcher
  • That panel layout is persisted per project
  • That dirty diagrams are guarded when switching

Next Steps

Section titled “Next Steps”