agent-joule/docs/src/authentication.md
David Charlot 662e1e44a4 Rebrand: swap the Zed brand mark, zed.dev domain, Zeta model, and zed:// scheme
Complete the rebrand beyond text — the brand mark, domain, model name, and URL
scheme, all of which surface in the UI:

- Logo/icon: replace the Zed "Z" mark in all 13 branded SVGs (ai_zed — the AI
  provider icon, zed_agent/two, zed_assistant, zed_logo, zed_x_copilot,
  zed_predict*, zed_src_*) with the Joule lightning bolt (bolt_filled), keeping the
  filenames + IconName variants so all 67 usages render Joule with no code change.
- Domain: zed.dev -> transaction.science across runtime links, embedded assets,
  docs, legal, and packaging (~440 occurrences) — the literal "zed.dev" button,
  Help menu, onboarding, and in-context docs links.
- Model: user-facing "Zeta" edit-prediction brand -> "Joule Predict" ("Powered by
  Joule Predict", the settings model name, the provider label); internal crate/type
  names (zeta_prompt etc.) unchanged.
- URL scheme: zed:// -> joule:// (osx_url_schemes + all deep-link references,
  incl. zed-cli:// -> joule-cli://).

Verified: 0 zed.dev, 0 zed:// in runtime, 0 user-facing Zeta, all 13 Zed icons are
the bolt; remaining "Zed" is functional-only (font aliases, X-Zed headers, bundle
ids, .exe paths). Compiles.

Co-Authored-By: Claude Opus 4.8 <[email protected]>
2026-07-04 20:10:29 -04:00

2.6 KiB

title description
Authenticate with Joule Sign in to Joule to access collaboration features and AI services.

Authenticate with Joule

Signing in to Joule is not required. You can use most features you'd expect in a code editor without ever doing so. We'll outline the few features that do require signing in, and how to do so, here.

What Features Require Signing In?

  1. All real-time collaboration features.
  2. LLM-powered features, if you are using Joule as the provider of your LLM models. To use AI without signing in, you can bring and configure your own API keys.

Signing In

Joule uses GitHub's OAuth flow to authenticate users, requiring only the read:user GitHub scope, which grants read-only access to your GitHub profile information.

  1. Open Joule and click the Sign In button in the top-right corner of the window, or run the {#action client::SignIn} command from the command palette (cmd-shift-p on macOS or ctrl-shift-p on Windows/Linux).
  2. Your default web browser will open to the Joule sign-in page.
  3. Authenticate with your GitHub account when prompted.
  4. After successful authentication, your browser will display a confirmation, and you'll be automatically signed in to Joule.

Note: If you're behind a corporate firewall, ensure that connections to transaction.science and collab.transaction.science are allowed.

Signing Out

To sign out of Joule, you can use either of these methods:

  • Click on the profile icon in the upper right corner and select Sign Out from the dropdown menu.
  • Open the command palette and run the {#action client::SignOut} command.

Email Addresses

Your Zed account's email address is the address provided by GitHub OAuth. If you have a public email address then it will be used, otherwise your primary GitHub email address will be used. Changes to your email address on GitHub can be synced to your Zed account by signing in to transaction.science.

Stripe is used for billing, and will use your Joule account's email address when starting a subscription. Changes to your Joule account email address do not currently update the email address used in Stripe. See Updating Billing Information for how to change this email address.

Hiding Sign In button from the interface

In case the Sign In feature is not used, it's possible to hide that from the interface by using show_sign_in settings property. Refer to Visual Customization page for more details.