This page is not translated yet, so it is shown in English.
Docs
Holarch Documentation
The complete reference for the Holarch web app, for SysML v2 and LML projects: every feature, how to use it, and its options and limits. For short step-by-step answers, see Help.
Getting Started
- Getting Started
Sign in, find your way around the Holarch window, and open the CubeSat EO-1 demo to learn the workflow.
- Tutorials
Eleven guided tutorials on a small Weather Station model, from the first requirement to a delivered specification, with a step panel that checks your work as you go.
- Home
The project's start page: what needs attention, where each lifecycle group stands, and two lanes of panels for the work, checks and status you follow, from next actions and process gates to risks, changes since the baseline and an AI project brief.
- Project Folders
Group projects in folders inside folders on the Projects page, in your own folders or in an organization's shared folder tree, and move them by drag, menu or keyboard.
- Your Account
Create a free account or accept an invitation, accept the Terms of Use, sign in (also with Google or Microsoft, or a passkey), verify your email, reset or change your password, change your email, set up two-step sign-in, manage signed-in devices, contact support, and delete your account.
SysML v2
- Getting Started with SysML v2 Projects
Choose between an LML and a SysML v2 project, create a SysML v2 project or a demo, write a first model and find your way around.
- SysML v2 Tutorials
Nine guided tutorials for SysML v2 projects, from the first package to ports, actions, states, requirements, verification, constraints and variants, with a step panel that checks your work.
- SysML v2 Textual Notation
The SysML v2 language as Holarch supports it, with examples from the Hybrid Car demo, the checks it runs, and the read-only Standard Library.
- The Text Editor and Browser
Write and check SysML v2 text in the Editor, browse the model tree in the Browser, keep text and views in sync, and restore deleted elements from the Trash.
- SysML v2 Views
Create, open and edit the views of a SysML v2 project (General, Interconnection, Action Flow, State Transition, Sequence, Grid, Geometry and the Requirement, Use Case, Parametric and Package presets), and use Holarch's analysis diagrams on the model.
- SysML v2 Variants and Configurations
Model a product line in a SysML v2 project: variation points, variants, rules and configurations in the Browser and the inspector, New Configuration…, views shown as one configuration, and trade studies of configurations.
- Requirements and Verification in SysML v2 Projects
Write, check, approve and track requirements and verification cases of a SysML v2 model with the Requirements, Quality, TBD/TBR, Links to Review, Approvals, RVTM, Verification Cases and Traceability Matrix pages.
- Evaluation, Units and Analysis in SysML v2 Projects
How a SysML v2 project evaluates attribute values with units, checks constraints, solves parametric views, rolls up budgets, scores trade studies and simulates action flows.
- Simulation Metadata in SysML v2 Projects
The HolarchSimulation metadata library: how a SysML v2 model carries durations, branch probabilities, loop counts, resources, costs and state machine settings for the Simulator, and how to write and move them.
- Exchanging SysML v2 Models
Import .sysml files, zip archives and SysML v2 JSON into a SysML v2 project with a preview, and export the model or a package as .sysml text or SysML v2 JSON.
- Importing SysML v1 Models
Convert a SysML 1.x model from Cameo, MagicDraw, Enterprise Architect, Rhapsody or Papyrus into SysML v2 text, review what changed form, and import it into a SysML v2 project.
- Converting Between LML and SysML v2
Make a SysML v2 copy of an LML project, or an LML copy of a SysML v2 project, with a report of what converts and what does not.
- The API and MCP in SysML v2 Projects
Read, search and check SysML v2 models from scripts and AI tools with a personal access token, propose changes that you review and apply in Holarch, and read and commit through the Systems Modeling API, where branches are change requests.
- Holarch Features in SysML v2 Projects
The Holarch pages around the SysML v2 model: the lifecycle rail, interfaces, risks and decisions, planning, documents and whiteboards, frameworks, comments, history, search, collaboration and Ask AI.
- The holarch Command Line Tool
Check, format and export SysML v2 models in builds and CI with the holarch command line tool and the Holarch Language Engine; GitHub Actions and other CI systems, JSON and SARIF reports, exit codes, sign-in with an API token or a license file.
Model
- Model and Database
LML entities, classes, attributes, relationships and labels, and the Database view that finds, edits, relates, reports on and restores them.
- Search All Projects
Find items by number, name, description or attribute text in every project you can open, grouped by project, and open a result in its project.
- Schema and Extensions
Tailor a project's LML schema with custom classes, attributes, choices, relations, labels and status workflows, and see how each change affects existing data.
- Diagrams
The Diagrams page, creating and opening diagrams, and the editor every diagram type shares: canvas, palette, selection, connections, line routing, formatting, alignment, zoom, annotations, export and thumbnails.
Requirements
- Requirements
Write, check, approve, baseline and import requirements, and track open TBD/TBR items and links to review.
- Documents
Write, structure, number, baseline and publish specifications as live views of the model, with templates, rich text, reports and Word output.
How to use it · Create a requirements specification from a template
- Document Generation
Put live traceability, verification and interface matrices and test reports into documents, export them in four formats, build them from a baseline, and mark them: a company notice, a DoD distribution statement, an export-control notice, a copyright or a contract number on every page and export.
- Traceability
Link requirements to functions, assets and tests, find coverage gaps, and see what a change affects with the Traceability Matrix, Spider diagram and RVTM.
- Links to Other Projects
Trace an item to a requirement, function or test in another project; each person sees the linked item only when they can open its project.
- Program Coverage
See which items of a project are linked from items in other projects, such as subsystem requirements and tests that trace to program requirements, and which links no longer resolve.
- Program Map
See how your projects link to each other, with link counts per pair of projects, and follow one item's chain of links through other projects.
Behavior
- Functional Analysis
Extract functions from requirements, arrange them into a functional flow, draw the FFBD, check coverage, and produce the requirements and functions tables and a Word report.
How to use it · Derive functions from a requirements document
- Action Diagrams
Model a functional flow with sequence, parallel, decision, loop and exit constructs, the items that pass between actions, the resources they use and the assets that perform them, then simulate it.
- Simulation
Run an Action flow as a Discrete Event simulation or a Monte Carlo study, read time, cost, resource and utilization results, script decisions, and record a verification result against a requirement.
Architecture
- SysML Diagrams
Block definition, internal block, parametric, state machine, use case, requirement, package, class, activity and sequence diagrams, and how each maps to the LML model.
- Budgets & TPMs
Roll mass, power, cost or any quantity up the system structure with part counts, contingency, allocations and margins, and track technical performance measures against a planned profile.
- Other Diagrams
Asset, Physical I/O, Interface Control, Layer, N2, I2, IDEF0, ICOM, Hierarchy, Tree, Spider, Radar, Risk, Timeline and Imported Graphic diagrams.
How to use it · Build a physical architecture and check its interfaces
Interfaces
- Interfaces
Define interfaces as Conduits, record what flows across them, check capacity, track interface maturity in the Interface Register, and produce ICDs, N² and I² matrices.
How to use it · Define an interface on an Internal Block Diagram
Verification
- Verification
Plan how each requirement is verified, organize test cases in suites, run tests with step results and evidence, save test cycles, and report coverage in the RVTM.
- Formal Program
Close verification formally with deviations, waivers, nonconformance dispositions and sign-off; run reviews with RIDs and gate records; answer a customer specification with a compliance matrix.
- Model Checks
Run 75 rule-based checks and your own rule sets over the whole model, narrow the findings by severity, class, rule and label, fix them in place, ignore the ones that are intended, and set how strict each rule is.
Safety & Reliability
- Safety & Reliability
Track hazards with their severity, likelihood, controls, verification and acceptance in the Hazard Log, analyse failure modes, effects and criticality in the FMECA worksheet, and compute probabilities with fault trees and reliability block diagrams.
Risks, Issues & Decisions
- Risks, Issues & Decisions
Rate risks on a project risk matrix, plan and track their mitigation, compare alternatives in weighted trade studies, test the result's sensitivity and record decisions.
Plan
- Project Management
Plan and track the work with Kanban boards, Gantt charts with dependencies, a project calendar, upcoming dates, board progress and a countdown clock, all built from Task and Time entities in the model.
- SE Process Guides
Follow a project through a systems engineering process (Kossiakoff, ISO/IEC/IEEE 15288, NASA, DoD, MIL-STD-499B or the Vee model) phase by phase, with checks read from the model, review gates, milestones and review packages.
- Spreadsheets
Excel-compatible spreadsheets inside a project: sheets, formulas, formats, tables, validation, named views with filters and sort, live model data, charts, Excel import and export, AI formula help and the API.
- Presentations
Build slide decks from the model, with layouts that stay linked to entities, diagrams and queries, a deck theme with a marked footer, and exports to PowerPoint, HTML, Word and images.
Control & Reviews
- Product Lines and Configurations
Model several products in one project with features and configurations, say which items apply to which products with Applies To and effectivity, view and edit the model as one configuration, and generate documents, RVTMs and baselines per configuration.
- Change Requests
Propose changes to approved or baselined items as a change request, have them reviewed and approved, then apply them in one step with a full record.
- Libraries
Publish a project's items as fixed releases and reuse them in other projects, shown read-only or as local copies that report what changed in later releases.
- Word and PDF Files as Artifacts
Add Word documents and PDFs to a project as Artifacts, review and comment on their pages, keep every version, and free storage by removing old versions' files.
- Project Activity
Every recorded edit in a project, newest first, with who made it, which item it touched and what changed; filter by date, person, class, kind of change and text, and export the list.
Frameworks
- Frameworks
Build DoDAF 2.02 products and UAF views from the model, including AV-1, the AV-2 Integrated Dictionary, OV-1 graphics from a whiteboard or an imported picture with hotspots and versions, rules models, matrices, consistency checks and the Word architecture package.
Whiteboards
- Whiteboards
Free-form boards for brainstorming, concept graphics, causal loops and sketches, with shapes, lines, sticky notes, clipart, military symbols, frames, tables and charts, linked to the model.
AI
- AI
Every AI feature in Holarch, how previews and approval work, AI keys and which key is used, the AI included in the Individual and Team plans, usage and limits, AI permissions, and what is sent to the provider.
- How Holarch Chooses AI Models
Why Holarch's AI uses Claude, and GLM 5.3 in mainland China, Hong Kong, Macau and Taiwan, with Kimi K3 and GLM 5.3 as own-key options: how models from Anthropic, OpenAI, Google and xAI are tested on Holarch's own AI tasks, the quality bar, the latest result, and how another model can be added.
- AI in Mainland China
How AI works in Holarch when you use it from mainland China, Hong Kong, Macau and Taiwan: GLM 5.3 included in the Individual and Team plans, your own GLM or Kimi key, where requests go, and what is not available yet.
Collaboration
- Sharing and Working Together
Share a project by role, edit it live with others, see who is present, work offline, resolve conflicts, and restore earlier versions or deleted items.
- Notifications and My Work
Mentions and replies, assignees and due dates, watching items, review notices, the bell, email notices and My Work, the inbox of what waits on you.
- Contributions and Class Review
See what each member of a project created, changed, commented on and approved; instructors compare each student's work with an assignment's due date and export a class roll-up.
Administration
- Organization Settings
Organization Settings for org admins of a class or a team: members and invitations, organization AI keys, the AI and API switches, two-step sign-in, markings, document templates, single sign-on, class status and the audit log.
- Single Sign-On and SCIM
Connect an organization's SAML 2.0 identity provider (Okta, Microsoft Entra ID, Microsoft AD FS, Google Workspace, Ping), or a self-hosted server's Active Directory directly, verify its email domains, require single sign-on, map groups to roles, and provision accounts with SCIM 2.0.
Reference
- Keyboard Shortcuts
Every key and gesture Holarch responds to, grouped by page and editor.
- Import and Export
Every way to bring data into Holarch (Word, Excel, CSV, ReqIF, XMI, text, Holarch backups and project files, schemas, matrices) and every export format, with all options, the .holarch backup format and the project JSON format.
- Attachments, Storage and Limits
How Holarch stores files in projects, which files you can add, the virus scan, the storage meter, the limits of each plan (storage, projects, collaborators, items, version history), image downscaling, removing files and when unused files are deleted.
- System Requirements
The browsers Holarch runs in, how much computer memory (RAM) a project of each size and language needs, and how long large projects take to open.
- Data and Security
Where Holarch keeps your projects and files, how saving, earlier versions, the Trash and your own backups work, who can open a project, what stays in your browser and what is sent to AI.
- API and MCP
Read and change projects from scripts with a personal access token (REST API at /api/v1), and let AI tools read them and propose changes you review (MCP at /mcp); scopes, project lists, the organization switch, limits and examples.
- The Python Client
Read Holarch projects, search items and propose changes for review from Python scripts with the free holarch-api package; installation, sign-in, every method, proposals, errors and limits.
- Recipe: Jira
Connect Holarch requirements to Jira issues with the REST API, and turn Jira issues into reviewed Holarch changes through Claude; setup, a sync script, a worked example and troubleshooting.
- Recipe: GitHub
Run Holarch Model Checks from GitHub Actions and track the findings as a GitHub issue, and let Claude Code propose test cases for the requirements a branch implements; setup, a workflow file, a worked example and troubleshooting.
- Recipe: Test Results Through Claude
Bring results from a test system into Holarch test cases, with a REST script for CI or with Claude, which runs the tests, proposes the results for review and reports what the RVTM shows; setup, a script, a worked example and troubleshooting.
- Troubleshooting
Fixes for common problems with saving, signing in, AI, shared projects, attachments and the display, each with its cause and fix, and how to contact support.
- Glossary
Every acronym used in Holarch, with what it stands for and a short definition.