Skip to content
Weld Weld Docs

Getting started

This page is for people who have been invited to a team’s Weld hub. It takes you from the invite email to a Claude Code session that is coordinating with your teammates. For a longer, screen-by-screen version, follow Join a hub from a Mac or Set up a Windows PC.

What you need

Section titled “What you need”
  • A Mac (Apple silicon) or a Windows PC. Linux works for hubs and build machines.
  • A Claude Code subscription on your own account. Weld runs your agents under your account only.
  • The invite: a project owner ran weld invite <your email>, and your hub sent you a welcome email with the install steps, the hub’s address and what to run. The invite is tied to that email address and expires after 7 days unless the owner chose otherwise.
  • For the asset pipeline only: an NVIDIA GPU with 12 GB or more of VRAM. Without one, you send GPU work to a teammate’s machine.

Weld checks for the rest during the join and installs it after showing you each command and asking: Git, Git LFS and the Claude Code CLI everywhere, plus Blender and uv on asset machines. Unreal Engine 5.8 needs your Epic login, so on build machines Weld installs and opens the Epic Games Launcher and prints the steps.

1. Sign this machine in

Section titled “1. Sign this machine in”

Run the command from your welcome email in a terminal. It’s one of these:

Terminal window
weld node                                    # on Weld's default hub
weld node --hub https://<your-hub>           # on your team's own hub
weld node https://<your-hub>/join/<code>     # if you were sent an invite link

weld node always prints which hub it picked. Then:

  1. New to this hub? Answer no to “already have an account?” (or pass --email). The hub emails you a 6-digit code; enter it with the address you were invited at, and your invite is accepted: your account, project membership and a passkey for the web dashboard are created.
  2. Already have an account on this hub (adding a second machine)? Answer yes: your browser opens the hub’s device page, you sign in with your existing passkey and approve the machine.
  3. Weld lists your projects, asks which is the default if there are several, names the machine after its hostname (--node-name changes it) and sets up git credentials, telemetry and the Claude Code plugin.
  4. It checks prerequisites, shows the exact install command for anything missing and asks “Install them now? [Y/n]”. Large downloads such as Blender get their own question.
  5. It asks whether to share your Claude Code prompt text and tool details with the hub’s ops view (metrics and costs are always sent). --share-prompts or --no-share-prompts answers up front; weld node telemetry changes it later.
  6. It offers to keep the node running in the background at login. Say yes.

At the end you get a green checklist. If something failed, join exits non-zero and lists the retry under “Next steps”.

2. Get the game

Section titled “2. Get the game”
Terminal window
weld clone "<Project>/<repo>"     # e.g. weld clone "Emberfall/emberfall"

weld clone sets up credentials and Git LFS for you and links the checkout to the project (it writes .weld/project.toml). Already have a clone? Run weld node link and then weld git setup inside it instead.

3. Start Claude Code

Section titled “3. Start Claude Code”
Terminal window
cd <repo>
claude

That’s it. At session start, Weld adds a short note with your active Work, inbox, handoffs, overlaps and conflicts. When you ask Claude to build something, the weld-coordination skill declares a Work item before the first edit, and your teammates see it on their dashboards within a second. See Using Weld with Claude Code.

4. Check everything is green

Section titled “4. Check everything is green”
Terminal window
weld status    # hub link, project, your Work, handoffs, inbox, and what to do next
weld doctor    # checks this machine and fixes what is safe
weld login     # opens the web dashboard, signed in

Next steps

Section titled “Next steps”