Getting started

Try it on your laptop

Download the desktop app with local server from the Releases page (Windows x64, macOS Apple silicon, Linux x86_64), start it and click Try TeamCraft on this computer: the app starts a private server with its own database on your computer and opens the browser, where you create the administrator. With PostgreSQL installed, teamcraft local does the same on the command line. Details: Try it on your computer.

Install on Linux with Docker

curl -fsSL https://raw.githubusercontent.com/rudalabs/TeamCraft/main/deploy/install.sh | bash

TeamCraft and PostgreSQL run as containers; the script offers to create the administrator at the end. See Install with Docker.

Build and run

You need Rust (stable, via rustup) and PostgreSQL 16 or newer. The repository’s docker-compose.yml starts a development database that needs no password:

git clone https://github.com/rudalabs/TeamCraft.git && cd TeamCraft
docker compose up -d db
cargo run --release

TeamCraft applies its database migrations on start and listens on http://localhost:8080. The platform guides cover native PostgreSQL installations and the desktop app: Linux · macOS · Windows.

First start

1. Open http://localhost:8080. A server without accounts that listens on localhost offers Create the administrator – pick a username and a password (10+ characters). The form disappears afterwards.
2. Projects → New project group: every item belongs to one. The creator manages the group and adds the team members.
3. Admin → Users (admins): create accounts for your team, or connect single sign-on (see Users, roles and SSO).
4. Items → New item: choose the CAD file (s) first – the model, its drawing and a STEP export for the 3D preview. Name and type are taken from the first file (an assembly for .iam, .asm, .sldasm, …). The item is created together with its files; its first revision A is in work and checked out to you.
5. Check in, then release it with a change order.

Appearance: TeamCraft follows the light or dark appearance of your operating system. The menu under your name (top right) and Account → Appearance switch between System, Light and Dark; choose Dark to keep the dark look of earlier versions. The distribution skins (Arch, CachyOS, EndeavourOS, KDE, Kubuntu, openSUSE, Ubuntu) are dark. The choice is personal and also styles the login page in that browser.

Preferred CAD program: if your parts exist in several CAD formats, Account → Preferred CAD program shows the files of your program (and all neutral formats such as STEP) first and collapses the native files of other programs – see Files. The setting is personal and applies in the browser and the desktop app.

Keyboard: / or Ctrl+K (⌘K) jumps to the search field. The single-key / can be switched off under Account → Appearance → Keyboard (per browser).

Keyboard: / jumps to the search field (on the vault explorer: to its filter); in menus, Esc closes and the arrow keys move.

On a server that is reachable from other machines, create the first administrator from the command line instead:

teamcraft user create --username admin --role admin      # prompts for the password

Command line