Tutorials

Learn how to use Artifact

Get started with the quickstart guide, or dive into the detailed tutorials.

Quickstart Guide

Detailed Tutorials

In-depth, step-by-step guides for every feature in Artifact.

Tutorial 1: Welcome to Artifact

Onboard

Understand Artifact and learn the workspace

1
Video

Welcome to Artifact

  • What Artifact is and which engineering problems it solves
  • How the tutorial series is structured and the order to follow it
  • The core mental model: organizations, projects, diagrams, variants, harnesses, and the library
5 min readOpen tutorial →
2
Video

App Overview

  • The two-column layout (sidebar tabs + editor tabs) and what each region is for
  • How to open, create, rename, duplicate, and delete projects and diagrams
  • Where to find the **Library**, **Harnesses**, **Nets**, **ERCs**, and **Comments** panes
8 min readOpen tutorial →

Design

Library, diagrams, channels, harnesses, design blocks, and library search tools

3
Video

Building Library Parts

  • The structure of the Artifact library and the part types you can create
  • How to create a connector with pins and a default contact part number
  • How to create custom wires and cables with insulation colors and gauges, and standard interface cables (USB, Ethernet, HDMI, …)
17 min readOpen tutorial →
4

Library Search Tools

  • How to query and export your library
  • How to bulk-edit parameters with a CSV round trip
  • How to bulk-create items with the **Bulk Library Upload Wizard**
1 min readOpen tutorial →
5
Video

Make your First Diagram

  • How to create a new diagram
  • How to place library parts on the canvas
  • How to connect components together — pin-to-pin wires, bulk wiring with **Quick Connect**, and dragging a cable in from the Library
12 min readOpen tutorial →
6

Split Connectors

  • How to split a large connector into separate boxes ("islands") and merge it back
1 min readOpen tutorial →
7

Designing with Channels

  • What a **channel** is and how it differs from ordinary pin-to-pin wires
  • How to set organization-wide **channel defaults** so new channels arrive pre-wired with a cable or bundle
  • How to draw a channel between two devices and edit its cable / bundle and per-wire properties
7 min readOpen tutorial →
8

Custom Protocols

  • How to create a custom channel protocol
  • How to define a multi-protocol channel
1 min readOpen tutorial →
9

Standard Interfaces

  • What standard interfaces are for, and when to use them instead of pins or channels
1 min readOpen tutorial →
10
Video

Harness Editor

  • How a "harness" relates to your diagram and how to assign wires to a harness
  • How to open the harness editor and read its canvas (ports, segments, placards)
  • How to add waypoints, bundle segments, and pick curve types and direction
9 min readOpen tutorial →
11

Design Blocks

  • What a Design Block is and how it relates to a diagram version
  • How to generate a design block interface from one of your diagrams
  • How to control which ports are visible by default on instances
8 min readOpen tutorial →

Release

Versioning, exports, BOMs, and the System Configuration dashboard

12
Video

System Configuration & Versioning

  • How systems, **variants**, **checkpoints**, and **releases** relate
  • How to open the System Configuration dashboard and read the system hierarchy
  • How to save, open, and restore checkpoints, and create variants
4 min readOpen tutorial →
13
Video

BOMs & Exports

  • How to open and filter the Bill of Materials (BOM) and export it to CSV — from the diagram or harness editor
  • How to use the Connections Table for pin-to-pin documentation
  • How to generate a harness Cut List for manufacturing
6 min readOpen tutorial →

Integrate

Connect harness data with Onshape and NX

14
Video

Linking Artifact to Onshape

  • What the Artifact ↔ Onshape integration syncs in each direction
  • How to generate Onshape API credentials with the right permissions
  • How to set up the **3D CAD Bridge** for a specific harness
6 min readOpen tutorial →
15

Linking Artifact to NX

  • How the Artifact ↔ Siemens NX integration works (offline file exchange, no API)
  • How to export your harness as **`.plmxml`** (the preferred format for NX Routing) and, when needed, the legacy **`.hrn`** + **`.cmp`** CSV pair
  • How to use **Import Lengths** to pull routed wire lengths back from NX into Artifact
7 min readOpen tutorial →

Enterprise

Collaboration, admin, Copilot, and the API

16

Collaboration

  • How presence indicators show who else is in the project and on which tab
  • How simultaneous draft co-editing works (and what its limits are)
  • How to leave, resolve, and reply to comments on a diagram
6 min readOpen tutorial →
17

Admin Options

  • Where the admin controls live in the UI and who can see them
  • How to invite teammates, change their permission level, and remove them
  • How to configure organization-wide settings (domain auto-add, API access policy)
7 min readOpen tutorial →
18

Using the Copilot

  • What the **Artifact Agent** (Copilot) is and what it can do for you
  • How to open the chat panel and start, switch, rename, and delete chats
  • How to ask it to find parts, build and edit diagrams, and run checks
5 min readOpen tutorial →
19

Using the Artifact API

  • What the Artifact REST API provides and how it relates to the in-app exports from Tutorial 13
  • How to get an API key and open the interactive [API documentation](https://app.artifact.engineer/api/v1/docs)
  • The resource hierarchy you walk when pulling data (organization → project → diagram → version → harness)
7 min readOpen tutorial →
Glow effect