Getting Started
Getting Started
Listen to this page 49 min
Sign in, find your way around the Holarch window, and open the CubeSat EO-1 demo to learn the workflow.
On this page
Holarch is a model-based systems engineering workbench. Each project is one model, from stakeholder needs to verified design, in one of two languages: SysML v2, which you write as text and edit in diagrams, or the Lifecycle Modeling Language (LML), which you work in diagrams, tables and forms. Requirements, functions, architecture, interfaces, tests, risks and decisions live in that model. Every page is a view of it.
Holarch is pronounced /ˈhoʊ.lɑːrk/ ("HOLE-ark"). The name comes from holarchy, Arthur Koestler's term for a hierarchy of holons: parts that are also wholes, as a subsystem is part of a system and a system in its own right. Holos is Greek for "whole".
A change on one page shows on every page that uses the same item. For example, rename a function on a diagram and the new name appears in documents and tables too.
This page shows how to sign in, find your way around the window and change how it looks. It includes a guided first session with the CubeSat EO-1 demo project.
Concepts
- Project: one model with its own requirements, diagrams, documents and members. You work in one project at a time. Switch projects from the project name in the top bar.
- Project type: every project is a SysML v2 project or an LML project. You choose when you create it. This page uses the CubeSat EO-1 demo, an LML project; the Hybrid Car demo is a SysML v2 project. See Two project types.
- Entity (item): one element of the model, such as a Requirement, an Action (function), an Asset or a Test Case. Every entity has a class and a name. It can also have a number, a description, attributes and relationships. See Model and Database.
- Lifecycle groups: the navigation rail groups pages in the order of the systems engineering lifecycle: Home, Needs & Requirements, Behavior, Architecture, Interfaces, Verification, Safety & Reliability (when that program feature is on), Risks, Issues & Decisions, Plan (with Whiteboards and Presentations), Control & Reviews and Frameworks.
- Overview page: the start page of a lifecycle group (every group except Home). It shows live numbers, a card per page and recent diagrams.
- Editor: a page that edits one item, such as a diagram, document, whiteboard, entity, chart or presentation. Open editors stay as editor tabs under the top bar.
- Inspector: the panel on the right that shows the properties of the selected item on any page.
- Role: your access to a project:
- Owner: edits, shares, transfers and deletes the project.
- Editor: edits content and restores earlier versions.
- Reviewer: reads, comments, and approves or rejects requirements; cannot edit the model.
- Viewer: reads and exports, and cannot change anything.
- Saving: Holarch saves every change to the server automatically. Every change can be undone. There is no Save button.
How to use it
When and why
Start here the first time you use Holarch. Come back when you need to find a page or a setting.
The frame around each page is the same everywhere: the rail, the top bar, the editor tabs and the inspector. Learn it once and you can move through the whole lifecycle: capture requirements, derive functions, build the architecture, define interfaces, verify, manage risk and deliver.
Sign in for the first time
Create a free account yourself: on the sign-in screen at https://app.holarch.app/, click Create a free account, fill in the form, select I agree to the Terms of Use and Privacy Policy, and open the link in the confirmation email. The steps are in Your Account.
A new account you created yourself chooses its first demo. Until you pick one, Manage Projects shows Start with a demo project with each demo and what it shows, such as CubeSat EO-1 (LML, guided systems engineering). A dot marks Project Files ▾ → New Demo Project, where the same demos are. Click a demo to build and open it; it becomes your sample project, listed first with the note "A sample project to explore. It does not count toward your plan's limits. Delete it any time." Like a tutorial project, it does not count toward your plan's active projects, and it holds up to 2,000 items (more when your plan allows more). Start a Blank Project makes an empty project and keeps the choice; Dismiss hides it for good. A deleted sample is not created again. Accounts that join through an invitation or an organization start with the projects shared with them instead.
With an invitation from a project owner or an administrator:
- Open the invitation email from Holarch and click its link. The link is valid for 7 days.
You see Create your account, with your email address filled in. You cannot change it.
- Enter Your name. Other members see this name.
- Enter a Password (at least 12 characters).
- Enter it again in Repeat the password.
- Choose an answer under How will you use Holarch? (required). How did you hear about Holarch? is optional.
- Select I agree to the Terms of Use and Privacy Policy. Create Account stays disabled until the box is selected.
- Click Create Account.
You see "Account created." Holarch opens the project you were invited to on its Home page. An account invitation without a project opens Manage Projects.
If you already have an account, the link opens Join project instead. Enter your password, select I agree to the Terms of Use and Privacy Policy if it is shown, and click Sign In and Accept. See Signing in for every screen.
Take the welcome tour
The welcome tour shows the main areas of Holarch in about three minutes, on a demo project: the rail and ⌘K / Ctrl+K, Home, the Database (the SysML v2 Editor in a SysML v2 project), a diagram, requirements Quality, the RVTM, Documents, Ask AI with a real question about the demo, and how AI changes are shown as a preview before they are applied. Each step opens its page and outlines the area it describes. The tour changes nothing in the model.
It starts by itself the first time a new account signs in.
- Click Start Tour on the Welcome to Holarch card. Choose the demo first: CubeSat EO-1 (LML) or Hybrid Car (SysML v2). Holarch opens the demo project. A new account's first demo is its sample project, which does not count toward the plan's limits.
- Read each step and click Next, or press → while the card has focus. Back (or ←) returns to the previous step.
- On the Ask AI step, click Ask This Question to send the shown question to Ask AI. Without AI on your plan, the step says so and offers See Plans… instead.
- Click Finish on the last step.
Close the card with Esc, × or Not Now to pause it: the tour continues at the same step the next time you open Holarch, or with ⌘K / Ctrl+K → Resume the Welcome Tour. Skip Tour ends it, and it does not start by itself again.
To take the tour again, click Take the Welcome Tour in Help → Help Center, choose Welcome Tour in the account menu, or press ⌘K / Ctrl+K and type tour. Started inside a project, the tour shows that project.
On a phone, the tour is five short cards without outlines.
Open the demo project
The demo project is a complete model of CubeSat EO-1, a 6U earth observation satellite. Use it to learn Holarch before you build your own model.
- Click Manage Projects at the bottom of the rail.
- Click Project Files ▾.
- Click New Demo Project. When the menu shows more demos, choose CubeSat (Guided systems engineering). With no projects yet, the page's own New Demo Project button offers the same choices.
You see the new project's Home page.
- Read the Needs attention cards at the top. In a new demo project they show:
- Links to review: 6
- Overdue TBDs: 1 (of 3 open items)
- Failing tests: 2 (TC-04 Pointing Accuracy Test and TC-09 Safe Mode Entry Test)
- High risks: 2 (RK-1 Reaction Wheel Failure and RK-3 Launch Slip)
- Model checks: 33 (0 errors, 33 warnings)
- Save status: Saved
Cards with a count of zero, such as TPM breaches, are left out. The numbers can change as the demo content grows.
Move around the model
Use the rail to browse by lifecycle stage. Use the command palette (⌘K / Ctrl+K) to jump to anything by name.
- Click Needs & Requirements in the rail.
You see its overview page. The rail lists the group's pages under it: Documents, Requirements, Quality, TBD/TBR, Links to Review, Approvals and Import and Export (and Compliance Matrix with the Formal program).
- Click Documents.
- Open EO-1 System Requirements Specification.
You see the document in an editor tab under the top bar.
- Click requirement 3.1 Orbit Average Power in the document.
You see its attributes, relationships and comments in the inspector on the right.
- Press ⌘K / Ctrl+K and type
deploy.You see the function Deploy Solar Arrays under Items.
- Press Enter.
You see the function in the Item View, in a second editor tab.
- Click the first tab to return to the document.
Open tabs stay open after a reload.
Find what needs attention
Holarch counts the items that need attention, such as links to review and failing tests, and shows the count in the top bar.
- Click the Needs attention button in the top bar. It is the flag icon with a number.
You see the Needs attention list, for example "1 · Overdue TBDs — …".
- Click an entry.
You see the page that holds the data, here TBD/TBR.
The same counts appear as badges on the rail groups. From any page, you can see which stage needs attention.
Work through the lifecycle
Work through the rail groups from top to bottom. Each stage has its own reference page or how-to:
- Capture requirements in a document or import them: Documents, Requirements, Import and Export.
- Check their quality, resolve TBD/TBR items and get them approved: Requirements.
- Derive functions and a functional flow: Turn Requirements into Functions and an FFBD.
- Build the architecture and interfaces: Build the Architecture and Produce an ICD.
- Plan and run verification, and trace coverage: Traceability, Set Up Verification.
- Manage risks and decisions: Risk Register, Trade Study.
- Baseline and deliver: Produce a Review Package.
Worked example: a first session with CubeSat EO-1
This session follows one requirement from the Home page to a simulation.
- Create the demo project (see Open the demo project).
- Look at the Lifecycle cards on Home. Each shows the main number of one group, for example:
- 32 requirements (18 approved · 9 in review)
- 82 functions (28 of 32 requirements allocated)
- 11 of 32 verified (3 failed · 3 without a test)
- Click the Needs & Requirements card.
You see the requirement count with a bar of approved requirements. The overview also shows documents, open TBD/TBR items (with the number overdue), links to review and requirements awaiting approval.
- Click the links to review tile.
You see Links to Review. It lists the links of requirements changed after the SRR Baseline. Each one needs a review.
- Press ⌘K / Ctrl+K and type
6.5. - Open 6.5 Planning Cycle Time.
You see its status, In Review. It has a Measure but no simulation result yet.
- In the rail, click Behavior, then Simulator.
- Choose Run Nominal Imaging Pass.
The simulation checks the 100-minute requirement. See Simulate and Check Against a Requirement.
- Open a diagram and press ⌘. / Ctrl+. to read it in focus mode. Press Esc to leave focus mode.
- Click ? in the top bar.
You see the Help topic for the current page.
Tips and good practice
- Use ⌘K / Ctrl+K when you know the name. It finds pages, items by name or number, documents, diagrams and whiteboards. It also runs actions such as New Requirement… or Export RVTM (Excel).
- Pin the inspector (⌥⌘\ / Ctrl+Alt+\) to review many items in a row. It then stays open between selections.
- Save space on a laptop. Collapse the rail to icons with ⌘\ / Ctrl+\. To give only diagram and whiteboard editors the full width, set Navigation in diagram and whiteboard editors to Hidden in Preferences.
- Close tabs you no longer need with Close Other Tabs in the tab list (▾). Holarch keeps at most 30 tabs.
- Undo freely. Every edit can be undone with a single Undo (⌘Z / Ctrl+Z). The top bar's Undo and Redo buttons show whether there is anything to undo.
- Look up acronyms. Point at a word with a dotted underline, such as RVTM or FFBD, to see what it stands for. The Glossary lists every acronym Holarch uses.
Common mistakes
- "View only: ask an owner for edit access." Your role in this project is Viewer. Ask an owner to change your role in Share. See Viewer mode.
- The inspector disappeared. You hid it with × or Esc. To bring it back, click the edge tab Inspector · … at the right, or the inspector button in the top bar.
- The rail disappeared. It is hidden. Point at the strip on the left edge to peek, click it to bring the rail back, or press ⌘\ / Ctrl+\.
- Keys do nothing. Shortcuts are ignored while a text field has focus. Click an empty part of the page or press Esc first. ⌘K / Ctrl+K works in plain text fields too.
- No AI answer. Point at ✦ AI for the reason: this month's included requests may be used up, or AI may be turned off for the organization or project. See AI control and Included AI.
How it connects
The window frame connects every feature:
- The rail and the overview pages follow the lifecycle.
- The problem counts come from the same checks as Links to Review, TBD/TBR, Test Center, Budgets & TPMs, Risk Register and Model Checks.
- The inspector shows the same entity panel as the Database. See Model and Database.
- The palette and Help use the same list of pages as the rail, so ⌘K / Ctrl+K finds every page in the rail.
The window
The window has four parts:
- the navigation rail on the left,
- the top bar at the top, with editor tabs under it when editors are open,
- the page header with the page's title, description and actions,
- the page in the middle,
- the inspector on the right.
A Skip to content link is the first stop for Tab and moves focus to the page.
Narrow windows. At 760 px or less (for example at 200 % zoom on a 1280 px screen), side panels such as the Database Views pane, the matrix settings and the Schema class list fold away behind a narrow edge button. Click it, or press Enter on it, to open the panel over the page; Esc or a click outside closes it. The top bar wraps onto a second row, the page header puts its actions under the title, and at 900 px or less the inspector opens over the page. At 600 px or less the rail is hidden behind the strip on the left edge (point at it or Tab to it to open it). A toolbar or table that scrolls sideways fades at the edge where more is hidden.
Messages. Short notes such as "Saved" appear at the bottom right for about 5 seconds; error messages stay for about 12 seconds and have a × to dismiss them. Messages never block the page: clicking where a message sits presses the button under it, and pointing at a message fades it so you can see what is underneath (its own buttons, such as Undo, still work). Pointing at a message, or moving focus into it, keeps it on screen. Screen readers announce each message, errors first.
Reduced motion. When the system setting to reduce motion is on, Holarch turns off its animations and transitions.
Navigation rail
Contents
The rail on the left lists every page, grouped by lifecycle stage. From top to bottom it has:
- Holarch logo: opens Home, or Manage Projects when no project is open.
- Lifecycle groups: Home, Needs & Requirements, Behavior, Architecture, Interfaces, Verification, Safety & Reliability (when that program feature is on), Risks, Issues & Decisions, Plan (with Whiteboards and Presentations), Control & Reviews and Frameworks. Click a group to open its overview page. Home opens the Home page. The current group lists its pages under it.
- More: appears only when an installed page belongs to no group.
- Tools at the bottom:
- Database: every entity in one table.
- Diagrams: every diagram.
- Trash: the entities deleted in this project (see The project's Trash).
- Schema: the project's classes, attributes, relations and labels (Standard Library in a SysML v2 project). Preferences… and AI Settings… are in the account menu.
- Help: Help Center, Keyboard Shortcuts, LML Basics (SysML v2 Basics in a SysML v2 project), Tutorials and About Holarch.
- Manage Projects: the project list.
- The rail toggle button (its label names the next state: Collapse to icons, Hide navigation or Expand navigation).
Without an open project, only Help and Manage Projects are available.
Pages of each group
| Group | Pages |
|---|---|
| Home | Home |
| Needs & Requirements | Documents, Requirements, Quality, TBD/TBR, Links to Review, Approvals, Compliance Matrix (Formal program), Import and Export |
| Behavior | Functional Analysis, Action Diagrams, FFBD, Simulator |
| Architecture | Assets, Block Diagrams, Asset Diagrams, Budgets & TPMs |
| Interfaces | Interface Register, ICDs, N² Diagrams, Items & I/O |
| Verification | RVTM, Test Center, Deviations & Waivers (Formal program), Traceability Matrix, Program Coverage, Model Checks |
| Safety & Reliability | Hazard Log, FMECA (when the program feature is on) |
| Risks, Issues & Decisions | Risk Register, Risk Diagrams, Trade Studies, Decisions, Issues & Actions |
| Plan | My Work, SE Process, Project Management, Charts, Whiteboards, Presentations |
| Control & Reviews | Change Requests, Baselines & Versions, Libraries, Reviews, Activity |
| Frameworks | DoDAF, UAF |
Requirements, Approvals, Assets, Items & I/O and Decisions are the Database filtered to one class or status. For example, Approvals shows requirements whose Status is In Review.
Program features
Some pages are only needed on formal programs. Two switches per project show or hide them, in Home ▾ → Project Preferences… under Program features:
| Switch | Shows |
|---|---|
| Formal program | Pages for contract programs with formal reviews, deviations and verification closure. |
| Safety & Reliability | The Safety & Reliability group of the rail. |
- Both are off in new projects and class projects. Until you set a switch, it is on when the project uses the DoD or NASA process guide (Plan → SE Process).
- Each switch lists the pages it shows. When a switch has no pages yet, the dialog says so, and a group without pages does not appear in the rail.
- Switching off hides the pages from the rail, ⌘K / Ctrl+K and the overviews. Their items stay in the project, and links to them still open.
- A change applies to everyone working on the project, and a single Undo takes it back.
Badges
A badge on a group shows how many problems it has:
| Group | Counted problems |
|---|---|
| Needs & Requirements | Links to review and overdue TBD/TBR items |
| Architecture | TPM breaches (measures past their threshold) |
| Verification | Failing test cases and model check errors |
| Risks, Issues & Decisions | High risks (risks at the top level of the risk matrix) |
Point at a badge to see what it counts, for example "Needs attention: 6 links to review, 1 overdue TBD/TBR item". The group's overview page names the same problems under its purpose, each with a link to its page. When the rail shows icons only, a dot on the icon marks a group with problems. Screen readers announce the group name with the same list.
The three states
| State | What shows | Use it for |
|---|---|---|
| Expanded | Icons, labels, and the pages of the current group | Learning the app, wide screens |
| Icons only | Icons only; point at an icon to see a flyout with the group's Overview and pages | Laptops; the default at 1280 px window width and narrower |
| Hidden | A slim strip with a grip on the left edge; point at it to peek | Maximum space for the page |
To switch state, press ⌘\ / Ctrl+\, click the rail toggle at the bottom of the rail, or run Cycle Navigation Rail from the palette. The order is expanded → icons only → hidden → expanded. A short message confirms the new state, for example "Navigation hidden. Point at the strip on the left edge to show it."
When the rail is hidden, a slim strip with a grip stays on the left edge of the window, so you can see the rail is still there. The page keeps its place; the strip never covers it.
- To peek, point at the strip. After a moment the rail slides in over the page without moving it. It hides again shortly after the pointer leaves the rail and the strip. While keyboard focus is inside the rail it stays open; Esc closes it.
- To bring the rail back, click the strip, or focus it with Tab and press Enter or Space. The rail returns to the state it had before you hid it: icons only or expanded.
- On a touch screen, tap the strip to show the rail. Tap the page to close it.
Your choice is kept in this browser. Until you choose, the rail is expanded above 1280 px window width and icons only at 1280 px and narrower. At 600 px and narrower it starts hidden, and a choice made there applies only to that width.
Editors can have their own state. In Preferences, set Navigation in diagram and whiteboard editors to Expanded, Icons only or Hidden. The default is Same as other pages. With an editor setting, the state you choose in a diagram or whiteboard editor applies to editors only.
Rail keyboard
- ↑ ↓ move between visible entries. Home and End jump to the first and last.
- → on a group moves into its pages: inline when the rail is expanded, into the flyout when it shows icons only.
- ← returns from the pages to the group.
- Esc closes an open flyout (such as Help) and returns to its button. In a rail that slid in over the page, it closes the rail and returns focus to the strip.
- Enter opens the focused entry.
Top bar
The top bar shows where you are and holds the controls you need on every page. They are always in the same place; the current page's own buttons are in the page header under it. Every button has a name: point at it to read it. From left to right:
| Control | What it does |
|---|---|
| Breadcrumb | The project name and the group of the current page. Click the group to open its overview. |
| Project name ▾ | Opens the project menu (see below). |
| Needs attention | The flag with the number of items that need attention; click for the list. |
| Search (⌘K / Ctrl+K) | Opens the command palette. |
| ✦ AI and ▾ | The AI control: Ask AI and the AI tools of this page. |
| Presence (⇄) | Live (changes reach everyone in the project at once) or Offline. Next to it: a round badge (initials) for each of up to 4 other people with the project open, +n for the rest, and a red count of edits that clashed. Point at or tab to a badge for the person's name, email, role, page and activity. Click ⇄ for changes and conflicts. See Sharing and Working Together. |
| Save status | Saved with the time, Saving… or Not saved — retrying. In a window narrower than 1280 px only its dot shows (a failed save still shows in full), and its text and View as are the first items in ⋯. |
| Undo / Redo | ⌘Z / Ctrl+Z and ⇧⌘Z / Ctrl+Shift+Z; disabled when there is nothing to undo or redo. |
| ? | Help for the current page. |
| ⋯ (View) | Switch to Dark Theme (or Light) and Focus Mode (⌘. / Ctrl+.). |
| Inspector | Shows or hides the inspector. |
| Share | Members and roles of this project. |
| Bell | Your notices, with the number of unread ones. See Notifications and My Work. |
| Your initials | The account menu. |
At 1000 px or less the search box shows as its magnifier; ⌘K / Ctrl+K works as before.
Page header
Under the top bar (and the editor tabs), every page starts with the same header:
- Title: the page's name, for example Test Center. In an editor it is the open item's name, for example the diagram's name next to its Diagram type selector. The Item View and an open document show only their actions here, because their own title row names the item.
- Description: on most pages, one line on what the page is for.
- Page actions at the right: the buttons of the current page, for example Export ▾, + New ▾ or Run Suite. There is at most one primary (filled) action, and it is last.
- More (⋯): when the window is too narrow for every action, the actions that do not fit move into More, exports and imports first. The title is never cut off to make room.
Project menu
Click the project name at the start of the breadcrumb to switch or manage projects. The menu lists:
- Your projects in one list: the projects you pinned first, then up to 12 others, most recently opened first. The open project says Open now.
- A star at the end of each row: ☆ pins the project, ★ unpins it. The menu stays open, and the order changes the next time it opens. With the keyboard, move to the star with the arrow keys and press Enter.
- Share Project…: members and roles (see Viewer mode and Sharing and Roles).
- Project Storage…: attachment storage of this project and its limit.
- New project…
- All projects: opens Manage Projects.
Baselines and earlier versions are on Control & Reviews → Baselines & Versions.
Needs attention list
Click the Needs attention button (the flag) to recount and list everything that needs attention. Click an entry to open its page.
- Each entry shows the number it adds to the count, the card title and the details, for example "2 · Failing tests — TC-04 Pointing Accuracy Test, TC-09 Safe Mode Entry Test". Model checks show as "n · Model check errors", with errors and warnings in the details.
- With nothing to do, the list shows Nothing needs attention.
- Open Home is always at the end.
- The button's tooltip reads "Nothing needs attention" or "n items need attention".
Holarch counts links to review, overdue TBD/TBR items, failing test cases, TPM breaches, high risks and model check errors. This is the same count as the Needs attention row on Home. Model check warnings are not counted, so the Model checks card on Home, which shows errors and warnings, can show a higher number. In a SysML v2 project, the text editor's status bar shows the diagnostics of the open text, which is a separate count.
Save status
| Label | Meaning |
|---|---|
| Saved time | The latest change is on the server. Point at it for "Saved to the server" and the last save time. |
| Saving… | A save is in progress. |
| Not saved — retrying | The server did not accept the change. Holarch retries automatically; click the label to retry now. The tooltip names the reason. |
| Not saved — changed on the server | Someone changed the project on the server after you opened it. Click to retry. |
| Offline – changes kept on this device | The connection is lost. Changes are sent when it is back; click to reconnect now. |
Sometimes a change cannot be saved and the browser cannot keep a copy either. Then a red banner appears: "Changes are not saved. Do not close this page." It has Retry and Download a copy (a project JSON file). You cannot dismiss it while the problem lasts.
Account menu
Click your initials at the end of the top bar. The menu has:
- the header with your name and email address,
- Account Settings: name, email, password, signed-in devices, invitations, AI keys and account deletion (see Your Account),
- Preferences… (see Preferences),
- AI Settings…,
- Organization Settings (organization administrators),
- Documentation: these Docs in a new tab, in your interface language where a page is translated. On a self-hosted server they come from the server itself, for the version it runs; elsewhere from holarch.app. ⌘K / Ctrl+K → Documentation opens them too,
- Contact Us…,
- Welcome Tour: the welcome tour from its first card,
- Sign Out.
AI control
Use the AI control in the top bar to ask questions about the project or run the AI tools of the current page. It appears on every project page.
- ✦ AI opens the Ask AI panel. Ask about this project or about how to use Holarch.
- Type a question and press Enter to send it. ⇧Enter / Shift+Enter adds a new line.
- An empty panel offers examples such as "Which requirements have no test case verifying them?"
- The panel header has AI settings (⚙), Clear chat history (⟲) and Close (×).
- The panel closes when you leave the project.
- ▾ lists the AI tools of the current page, for example quality review or function extraction, then AI Settings…. Pages without AI tools show only ✦ AI.
- In narrow windows the control shows as the sparkle and ▾.
- The same tools appear in the palette under AI tools for this page, with Ask AI… and AI Settings….
- AI changes to the model always show as a preview first. Once applied, a single Undo takes them all back.
The control is off in these cases:
| Situation | What you see |
|---|---|
| Free plan without an academic email address | “AI comes with the Individual and Team plans. Start a free 30-day Individual trial, or choose a plan.” with Start Trial and Choose Plan… (after the trial: “AI comes with the Individual and Team plans. Choose a plan in Account Settings → Plan & Billing.”). See Included AI. |
| No included AI requests left and no key of your own | Asking opens No AI Key: "Add an Anthropic key in Account → AI keys." with Open AI Keys. Everything else works without AI. See Add an AI Key. |
| This month's included requests are used up | “You've used this month's 75 included AI requests. They reset on November 1. Add your own Anthropic key in Account Settings → AI keys for more.” (the number is your plan's) |
| Your email address is not verified | “Verify your email address to use the included AI: open the link in the email from Holarch.” |
| Your organization turned AI off | "AI is turned off for this organization by its administrator." |
| The project contains markings that the service treats as restricted | AI Is Turned Off for This Project: "AI is turned off for this project: it contains markings that the service treats as restricted. Remove the markings or contact support." |
| You are a Viewer | "View only: AI tools need edit access" |
See AI and Ask AI and AI Tools.
Command palette
Use the command palette to open any page or item, or run an action, by typing its name.
- Press ⌘K / Ctrl+K or click Search in the top bar.
- Type part of a name or number.
You see the results in groups, with the matching text highlighted.
- Press ↑ ↓ to choose a result.
- Press Enter to open or run it.
Press Esc or click outside to close the palette.
Result groups:
- Pages: match page titles and their alternative words. For example,
n2finds N² Diagrams,srsfinds Documents,kanbanfinds Project Management andversion controlfinds Baselines & Versions. Other word forms work too:simulatefinds Simulator. Group overviews appear as the group name with Overview. - Pages That Are Off: pages whose program feature is off in this project, for example FMECA and Hazard Log (Safety & Reliability) or Deviations & Waivers, Compliance Matrix, Comments (RIDs) and Gate Records (Formal program). Each shows "feature is off" and Turn on and open. Choose one to turn the feature on and open the page; Undo turns it off again. Without edit access the entry is greyed, and its tooltip says to ask an owner or editor. See Program features.
- Open Tabs: shown only when nothing is typed.
- Actions: commands, listed below.
- Items: match an entity's name or number. A number match ranks higher; an item whose number does not match is not listed for having one. Each item shows its class in its class color. Selecting one opens its Item View.
- Documents, Diagrams and Whiteboards.
When an item, document or diagram name is what you typed or starts with it, its group is listed above pages and actions that match only through other words or word forms, so Enter opens it: pointing opens 2.1 Pointing Accuracy in the CubeSat demo.
Actions include:
- Create: New Requirement…, New Item…, New Document…, New Diagram…, New Whiteboard.
- Output: Export RVTM (Excel), Export entities…. With a document open: Export Document to Word, Print Document or Save as PDF… and All Document Exports….
- AI: Generate Risks with AI…, Ask AI…, the AI tools of the page, AI Settings….
- Project and account: Share Project…, Project Storage…, Switch Project…, Account Settings, Sign Out.
- Editing and window: Undo, Redo, Cycle Navigation Rail, Focus Mode, Pin Inspector, Toggle Dark Theme, Toggle Compact Density, Preferences….
- Help: Keyboard Shortcuts, About Holarch.
- The actions of the current page, for example the whiteboard's commands.
- For administrators: the administration actions.
- With no match: "No matches for "text". Try a requirement number, a page name or an action."
- Without an open project, the palette searches pages and actions only.
Editor tabs
Editor tabs keep several items open so you can switch between them. Diagrams, documents, whiteboards, entities, charts and presentations you open stay as tabs under the top bar. Each tab shows an icon, the item name and its kind, for example Document or the diagram type.
- Switch: click a tab.
- Close: click its × or middle-click it. Closing the current tab opens the next tab. If it was the last tab, the list page of its kind opens.
- Reorder: drag a tab. From the keyboard, focus a tab and press ⌥⇧← / Alt+Shift+← or ⌥⇧→ / Alt+Shift+→.
- Keyboard: ← → move between tabs. Delete or Backspace closes the focused tab.
- The ▾ at the end (with the number of tabs) lists Open Tabs (the current one marked •), Close Other Tabs and Close All Tabs.
- Tabs are kept per project in this browser and come back after a reload.
- Tabs of deleted items are removed.
- At most 30 tabs are kept. Opening more drops the oldest.
Inspector
The inspector shows and edits the details of the selected item. Select an item on any page to see its attributes, relationships, comments and metadata on the right. You can select a Database row, a document item, a diagram shape, an RVTM or register row, or a matrix header.
Diagram and whiteboard selections show their properties. With nothing selected, a pinned inspector shows "Select an item to see its properties here."
| Control | What it does |
|---|---|
| × (Hide inspector) or Esc (focus in the inspector) | Hides the inspector. The selection stays, and the edge tab Inspector · … (with the item name) at the right reopens it. Hiding also unpins it. |
| Pin | Keeps the inspector open even when nothing is selected. ⌥⌘\ / Ctrl+Alt+\ or Pin Inspector in the palette. |
| Left edge | Drag to change the width (280–600 px, default 340 px). Focus the edge and press ← → to resize in 16 px steps. |
| Inspector button in the top bar | Shows or hides it. |
Selecting another item opens a hidden inspector again. Width and pin state are kept in this browser. See Model and Database for the entity panel in full.
Focus mode
Focus mode hides everything except the page, for reading or presenting.
- Enter: press ⌘. / Ctrl+., choose ⋯ → Focus Mode in the top bar, or run Focus Mode from the palette. The rail, top bar, page header, tabs and inspector are hidden.
- Leave: press Esc or ⌘. / Ctrl+., or click Exit focus at the top of the window.
Home and overview pages
Home
Home is the project's start page. It shows what needs attention and where each lifecycle stage stands. The Holarch logo also opens it.
Needs attention has health cards; only the cards with a count above zero show, and with none, one card reads Nothing needs attention. Each card opens the page that holds the data:
| Card | Shows | Opens |
|---|---|---|
| Links to review | Links of changed requirements that wait for review | Links to Review |
| Overdue TBDs | Overdue TBD/TBR items, with the number open | TBD/TBR |
| Failing tests | Test cases whose status is Failed, by name | Test Center |
| TPM breaches | Measures past their threshold | Budgets & TPMs |
| High risks | Risks at the highest level of the risk matrix | Risk Register |
| Model checks | Findings, with errors and warnings | Model Checks |
| Save status | Saved, Saving… or Not saved; "Saved to the Holarch server" | Preferences |
Lifecycle has one card per group, with its main number and a bar where it applies. Click a card to open the group's overview.
The Recent work panel lists open tabs and recent documents (up to 6). When empty, it reads "Nothing opened yet. Open a document, diagram or whiteboard to list it here."
The Next actions panel lists up to 6 of the most urgent items, in this order:
- Rerun or fix failing test cases.
- Close TPM breaches.
- Review changed links.
- Resolve overdue TBD/TBR items.
- Mitigate high risks.
- Assign a verifying test to unverified requirements.
- Fix model check errors.
- "Write or import the first requirements" (in an empty project).
With nothing open, it reads "No open actions. The model has no failing tests, breaches, links to review or overdue TBDs."
Below these, two lanes of panels show the work and status you follow; Next actions and Recent work are panels too. See Home for every panel and how to arrange them. The page actions in the page header are Home ▾ (Add Panel…, Edit Description…, Project Preferences…, Export Project…, Reset Home…) and Continue: … (opens the most recent item you opened).
The counts update shortly after each change.
Overview pages
An overview page summarizes one lifecycle group. Click a group in the rail, or a Lifecycle card on Home, to open it. Each overview has three parts.
Live numbers for the group. The first tile is highlighted. Each tile opens its page.
| Group | Numbers |
|---|---|
| Needs & Requirements | requirements (approved and in review, with a bar), documents, open TBD/TBR (overdue), links to review, awaiting approval |
| Behavior | functions (requirements allocated, with a bar), requirements without a function |
| Architecture | assets (measures and breaches), TPM breaches, measures |
| Interfaces | agreed interfaces of the total (proposed, draft, not set, with a bar), over capacity, without capacity |
| Verification | verified requirements (failed, without a test, with a bar), test cases (failing), model check findings (errors), deviations and waivers awaiting approval (Formal program) |
| Safety & Reliability | hazards that need attention (hazards, at High or Serious), failure modes over the FMECA limit (RPN at or above the limit, or severity class I–II) |
| Risks, Issues & Decisions | high risks (risks in the register), trade studies, decisions, open issues and actions (overdue) |
| Plan | tasks, whiteboards, presentations |
| Control & Reviews | baselines (latest date), open change requests (all in the log), review packages |
| Frameworks | framework products (DoDAF and UAF) |
Pages: a card for each page of the group, with a one-line description.
Diagrams: up to 12 recent diagrams of the group's types, and a link for each diagram type. When empty, it reads "No diagrams of these types yet. Create one from Diagrams."
Help and About
For help on the current page, click ? in the top bar, or press ? outside a text field. The matching Help topic opens in a panel beside the page, so the page, its selection and any open dialog stay as they were:
- Links in the topic open other topics in the panel; ‹ goes back.
- Search Help… at the top searches every topic.
- Open Full Help opens the Help page on that topic.
- Esc, × or ? again closes the panel and puts the focus back where it was.
Holarch calls each model element an item. The Lifecycle Modeling Language calls it an entity; ⌘K / Ctrl+K finds commands by either word.
Help in the rail opens Help Center, Keyboard Shortcuts, LML Basics (SysML v2 Basics in a SysML v2 project), Tutorials and About Holarch.
In the Help Center:
- Search the guide… is at the top of the topic list.
- Topics are grouped like the rail: Getting Around Holarch, the lifecycle groups, Working with Others, Settings & AI and Reference. How-tos come first in each group.
- A topic for a page has Open this page →. Without an open project, page topics say "Open a project to use this page."
- Help works without an open project too. Open Help in the rail from Manage Projects.
- A topic that these Docs cover more fully ends with Full documentation on holarch.app: and links to the Docs sections. On a self-hosted server it reads Full documentation: and the links open the server's own Docs.
About Holarch shows the Version of the running release. It links to What's new in Holarch, the changelog on holarch.app. Version numbers have the form major.minor.patch:
- Major releases can need action from you.
- Minor releases add features.
- Patch releases only fix problems.
- Versions below 1.0 are a beta.
- A page that stays open while Holarch is updated shows a banner at the top: "Holarch just got better. Reload to get the new version." The page keeps working until you click Reload, which saves the text you are typing before it loads the new version. In a project shared live, the banner adds "Your changes are kept and are shared after you reload.": your edits stay in this browser and reach the others after the reload.
Under Legal, About Holarch shows the copyright and trademark notice and links to Third-party licenses, the licenses of the open-source components Holarch includes. Holarch™ is a trademark of Holarch. On the hosted service, it also links to the Terms of Use.
The website Help at holarch.app/help has the same topics. This reference documentation expands on them.
Contact us: the account menu (top right) → Contact Us…, or ⌘K / Ctrl+K → Contact Us…, for questions, problems and feedback. On the hosted service it sends a request from inside the app under your account's verified address, and replies come by email (see Contact us). In the desktop app it opens the contact form with the name of the page you were on; nothing from your project is sent.
Email: [email protected]. Describe what you did, what you expected and what happened, with the exact message. Every Help topic ends with the same address, and replies to Holarch emails reach support too.
Acronyms
A dotted underline marks an acronym. Point at it, tap it, or move to it with Tab. A small card shows what it stands for and a one-line definition. In the app, Esc closes the card.
Where acronyms are explained:
- In the app: Help topics and their documentation links, page titles and descriptions, empty pages and group overview pages. Also the diagram type picker, the DoDAF and UAF catalogs, and inspector field names such as TBD Owner. In the catalogs, a product code such as OV-1 shows the product name.
- In the rail: pages named with an acronym (RVTM, FFBD, TBD/TBR) show the expansion as their tooltip.
- On holarch.app: Help and Docs pages explain the first use of each acronym in every section.
- Your own text (names, descriptions, documents) is left as typed. To explain acronyms there too, turn on Explain acronyms in your own text in Preferences. It applies to documents and descriptions while they are not being edited.
- Common file and web terms (AI, API, PDF, CSV, JSON and similar) are not underlined. They are in the Glossary.
The Glossary lists every acronym with its expansion and definition, A to Z.
Themes and density
Choose light or dark colors, and how tightly rows are packed.
Theme: Light, Dark or Match system (the default: Holarch follows your system's light or dark setting until you choose).
- Choose it in Preferences.
- To switch quickly between light and dark, choose ⋯ → Switch to Dark Theme (or Light) in the top bar, or run Toggle Dark Theme from the palette.
Density: Automatic (compact at 1440 px and narrower), Comfortable or Compact.
- Choose it in Preferences.
- To switch quickly between comfortable and compact, run Toggle Compact Density from the palette.
Diagram canvases, slides, charts and exports keep light-theme colors in either theme. Both settings are kept in this browser.
Language: Holarch is in English until you choose another language in Preferences. When your browser's language is one Holarch offers, Holarch asks once, in that language, whether to switch, and does not ask again. Emails from Holarch follow the same setting.
Preferences
Preferences control how the window looks and behaves in this browser. To open them, click your initials at the end of the top bar and choose Preferences…, or run Preferences… from the palette. The settings come in groups: Profile, Appearance, Editing, Keyboard, Storage (desktop app) and Reset. Every change applies at once; Done closes the dialog.
| Field | What it does |
|---|---|
| Your name | Your account name, read only. It is recorded on approvals, decisions, test runs and comments. Change it on the Account page. |
| Theme | Light, dark or browser theme. |
| Density | Automatic, comfortable or compact. |
| Language | The language of menus, buttons and messages: English, Deutsch, Español, Français, Italiano, Polski, Português (Brasil), Türkçe, Русский, Українська, 日本語, 한국어, 简体中文, 繁體中文, العربية, עברית or हिन्दी, each listed in its own language. English until you choose another; the app then reloads in that language. Help and Docs stay in English. New demo projects (Project Files ▾ → New Demo Project) are created in the interface language. In the SysML v2 Hybrid Car demo, the doc comments, comments and the Holarch data around the model are translated; element names and the project name stay English, as they are identifiers. |
| Navigation in diagram and whiteboard editors | Same as other pages, Expanded, Icons only or Hidden. |
| Time for dates entered without one | The time used when a date is picked without one (default 12:00 AM). |
| Acronyms › Show acronym explanations | On by default. Shows dotted underlines and cards on the app's own text. Turning it off removes them at once. See Acronyms. |
| Acronyms › Explain acronyms in your own text | Off by default. Also explains acronyms in documents and descriptions while they are not being edited. |
| Keyboard › Single-key shortcuts | On by default. Off turns off ? (Help for the page) and a whiteboard's single-key shortcuts (tool letters, /, type-to-edit). The same switch as a whiteboard's ⚙ → Single-Key Shortcuts; kept in this browser. |
| Reset Preferences… | Resets the interface settings kept in this browser: theme, rail and inspector state, pinned projects, editor tabs and column choices. Asks for confirmation first. Projects are not affected. Shows "Preferences reset". |
Both acronym settings are kept in this browser.
Language and formats. Holarch's interface is in English, German, French, Spanish, Italian, Polish, Brazilian Portuguese, Turkish, Russian, Ukrainian, Japanese, Korean, Simplified Chinese, Traditional Chinese, Arabic, Hebrew or Hindi (Preferences → Language). Every language other than English is marked Beta: it is machine-translated and in review, so some terms may still change. Names that come from the modeling languages stay in English in every language: LML class and relationship names (Action, Asset, Requirement, decomposed by …), EARS keywords and IDEF0's Input, Control, Output and Mechanism. When your computer's language is one of these and Holarch is in another, Holarch offers once, in that language, to switch (a computer set to Portuguese from Portugal is offered Brazilian Portuguese; Chinese for Taiwan, Hong Kong or Macau is offered Traditional Chinese, any other Chinese Simplified Chinese). Dates, times and numbers follow your browser's language and region: a German browser shows 29.10.2026, 14:05 and 1234,5, a Japanese one 2026/10/29 14:05. Digits are always 0–9, also for an Arabic browser. Right to left: in Arabic and Hebrew the interface is laid out right to left: the rail is on the right, menus open toward the left, tables and trees start on the right, spreadsheets show column A and the row numbers on the right, and ← and → in trees, tables, spreadsheets and tab lists follow that direction (formulas still read left to right). Diagrams, whiteboards, charts, slides, PDF and Word pages in the document viewer and the model text editor stay left to right, as engineering notation does; item names in any script, including names that mix Arabic or Hebrew with English, read in their own direction everywhere. Stored values do not change, so a project reads the same for everyone. Your model can be written in any language: names, descriptions and values keep accents, umlauts and Chinese, Japanese or Korean characters exactly as typed, and search, sorting, Model Checks and exports handle them. Help and Docs are in English; Ask AI answers in the language you ask in.
Click Done to keep the default time.
Signing in
Holarch needs an account. Create a free one on the sign-in screen, or open an invitation link from a project owner or an organization administrator. For a step-by-step first sign-in, see Sign in for the first time.
The sign-in screen appears whenever no one is signed in. It covers the whole window.
Screens
| Screen | Fields and buttons |
|---|---|
| Sign in | Sign In with a Passkey (browsers that support passkeys), Email, Password, Sign In, Forgot your password?. Below: "No account yet? Create a free account". With two-step sign-in on, Two-step sign-in follows (see Your Account). |
| Create an account | Email, Your name, Password, Repeat the password, How will you use Holarch?, How did you hear about Holarch? (optional), I agree to the Terms of Use and Privacy Policy, Create Account. Then Check your email. |
| We published Terms of Use and a Privacy Policy (accounts from before the Terms, once) | Links to both, Accept, Decline and Sign Out. |
| Reset your password | Email, Send Reset Link, Back to sign in. The link works for 1 hour. |
| Choose a new password | New password, Repeat the new password, Set Password and Sign In. Signs out every other device. |
| Create your account (invitation, no account yet) | Email (fixed), Your name, Password, Repeat the password, How will you use Holarch?, How did you hear about Holarch? (optional), the Terms checkbox, Create Account. |
| Join project (invitation, existing account) | Email (fixed), Password, the Terms checkbox (when needed), Sign In and Accept, Forgot your password?. When already signed in: Accept Invitation and Sign In with Another Account. |
| Email verified / Email changed | Confirmation, then Go to Sign In, Continue or Open Account Settings. |
After signing in, Holarch opens the page you were trying to reach, or Manage Projects.
Passwords
A password must:
- have 12 to 256 characters,
- not be a common password,
- not appear in published lists of leaked passwords,
- not be your email address.
Sessions
- A session ends after 8 hours of inactivity (an organization can choose a shorter time), after 14 days without use, and after 90 days in any case. Two minutes before an inactivity sign-out, Signing Out Soon offers Stay Signed In.
- When it ends, Holarch shows "Your session ended. Sign in again to continue; unsaved changes are kept in this browser." After you sign in, you return to the same page.
- Sign Out (account menu or palette) removes your cached projects from this browser and shows "Signed out."
- Account Settings → Signed-in devices lists every session with Sign Out, Sign Out Other Devices and Sign Out Everywhere.
Messages
A message about one field, such as an empty field or a wrong password, appears under that field, and focus moves to it; screen readers read the message and announce the field as invalid. Other messages appear next to the form's buttons.
| Message | Meaning and fix |
|---|---|
| "Enter your email address." / "Enter your password." | The field above the message is empty. |
| "Email or password is incorrect." | Check both; use Forgot your password? if needed. |
| "Too many failed sign-ins for this account. Try again later." | Sign-in waits longer after each failed attempt. Wait, or reset the password. |
| "Too many attempts. Try again later." | Too many requests from this network. Wait and retry. |
| "Verify your email address first. Check your inbox for the link, or send it again." | Click Resend the Verification Link. |
| "This account is disabled. Contact the administrator." | The account was disabled. Contact support at [email protected]. |
| "The password is too short. Use at least 12 characters." | Choose a longer password. |
| "The passwords do not match. Type the same password twice." | Retype the repeat field. |
| "This password is too common. Choose another one." / "This password appears in published lists of leaked passwords. Choose another one." | Choose a different password. |
| "Do not use your email address as the password." | Choose a different password. |
| "Enter your name." | Your name is empty. |
| "This invitation has expired or was already used. Ask the person who invited you to send a new one." | Invitations last 7 days and work once. |
| "This invitation is for address. Sign in with that address to accept it." | Click Sign In with Another Account. |
| "An account with this email address already exists. Sign in, then accept the invitation." | Click Sign in instead. |
| "This link is incomplete. Request a new one." | The link was cut off; request a new one. |
| "No access to this project, or it does not exist." | You are not a member of the project in the link. Ask an owner to invite you. |
Viewer mode
When your role in a project is Viewer, the project opens in view-only mode. You can read and export, but not change anything.
- A banner under the top bar reads View only "You can read and export this project. Ask an owner for edit access." with Show members.
- Edit buttons (new, add, delete, rename, import, approve and similar), menu items and property fields are disabled. Their tooltip reads "View only: ask an owner for edit access".
- Rich-text fields do not open for editing, and dropped files are refused.
- Undo, Redo and the ✦ AI control are disabled ("View only: AI tools need edit access").
- Opening, searching, filtering, zooming, the palette, Help, exports and downloads work as usual.
- Any attempt to change the project shows "View only: ask an owner for edit access." Nothing is saved.
- You can still create your own projects from Manage Projects or the project menu, and open Share to see the members.
An owner changes your role in Share. See Sharing and Working Together.
Shortcuts
| Keys | Action |
|---|---|
| ⌘K / Ctrl+K | Command palette (also in plain text fields) |
| ⌘\ / Ctrl+\ | Cycle the rail: expanded, icons only, hidden |
| ⌥⌘\ / Ctrl+Alt+\ | Pin or unpin the inspector |
| ⌘. / Ctrl+. | Focus mode; Esc leaves it |
| ⌘Z / Ctrl+Z / ⇧⌘Z / Ctrl+Shift+Z or ⌘Y / Ctrl+Y | Undo / redo |
| ? | Help for the current page |
| Esc | Close the top dialog or menu; hide the inspector when it has focus |
On Windows and Linux use Ctrl for ⌘ / Ctrl and Alt for ⌥ / Alt. Every shortcut is listed in Keyboard Shortcuts.
Limits
- Editor tabs: 30 per project. Opening more drops the oldest.
- Recent projects in the project menu: 12 (plus all pinned projects).
- Inspector width: 280–600 px.
- Palette results: up to 8 pages, 8 actions, 10 items, 6 documents, 8 diagrams and 6 whiteboards per search.
- Ask AI keeps the last 40 messages of a conversation.
- Invitation links: 7 days. Password reset links: 1 hour. Sessions: 8 hours of inactivity (or an organization's shorter time), 14 days without use, 90 days at most.
- Interface preferences (theme, density, rail, inspector, tabs, pinned projects) are kept per browser, not per account.