teamtype-join(1)            General Commands Manual           teamtype-join(1)

NAME
       teamtype-join - Join a shared directory via a join code, or connect to
       the most recent one

SYNOPSIS
       teamtype join [--sync-vcs] [--magic-wormhole-relay] [--iroh-relay]
       [--directory] [--iroh-dns-domain] [--iroh-pkarr-relay] [--username]
       [-t|--temporary-directory] [-h|--help] [-V|--version] [JOIN_CODE]

DESCRIPTION
       Join a shared directory via a join code, or connect to the most recent
       one

OPTIONS
       --sync-vcs
              EXPERIMENTAL: Also synchronize version-control directories like
              .git/ or .jj/, which are normally ignored. For Git, this will
              synchronize all branches, commits, etc. as well as your
              .git/config. This means that new commits will immediately appear
              at all peers, you can change branches together, etc

       --magic-wormhole-relay <MAGIC_WORMHOLE_RELAY>
              Use an alternative Magic Wormhole mailbox server relay url

       --iroh-relay <IROH_RELAY>
              Use an alternative Iroh relay url

       --directory <DIRECTORY>
              The shared directory. Defaults to current directory

       --iroh-dns-domain <IROH_DNS_DOMAIN>
              Use an alternative Iroh DNS origin domain

       --iroh-pkarr-relay <IROH_PKARR_RELAY>
              Use an alternative Iroh Pkarr relay server

       --username <USERNAME>
              The name that others see next to your cursor. Defaults to your
              Git username

       -t, --temporary-directory
              Create a new temporary directory and use it as the shared
              directory. The temporary directory is removed on exit. The
              temporary directory is created in `$XDG_CACHE_DIR/teamtype/`, or
              if `XDG_CACHE_DIR` is not set in `$HOME/.cache/teamtype/`, or if
              `HOME` is not set in `/home/$USER/.cache/teamtype/`

       -h, --help
              Print help

       -V, --version
              Print version

       [JOIN_CODE]
              Specify to connect to a new peer. Otherwise, try to connect to
              the most recent peer

VERSION
       v0.9.2 (e05a26724 2026-07-08)

                       join 0.9.2 (e05a26724 2026-07-08)      teamtype-join(1)