import { Steps } from "@astrojs/starlight/components";

Teak Desktop gives you a native macOS app with automatic updates and the same real-time sync as web and mobile.

## Requirements

- macOS 13.0 or newer
- Apple Silicon Mac (M1, M2, M3, or newer)
- Internet connection for sign-in and sync

## Install

<Steps>

1. Download the latest macOS build from [GitHub Releases](https://github.com/praveenjuge/teak/releases/latest).

2. Open the `.dmg` file.

3. Drag **Teak.app** to **Applications**.

4. Launch Teak from Applications.

</Steps>

## First Launch Security Checks

Teak desktop releases are signed and notarized.

If Gatekeeper blocks launch:

<Steps>

1. Open **System Settings → Privacy & Security**.

2. Find the Teak block message and choose **Open Anyway**.

3. Relaunch Teak.

</Steps>

## Sign In

Desktop sign-in opens a secure browser-based authentication window and returns you to the app automatically after login. The desktop app keeps its own session, so signing out on desktop does not sign you out of Teak in your browser.

## Teak Menu

The **Teak** menu in the macOS menu bar exposes these actions:

| Item                   | What it does                                                             |
| ---------------------- | ------------------------------------------------------------------------ |
| **About Teak**         | Shows the installed version, copyright, and app icon                     |
| **Check for Updates…** | Manually checks for new versions and shows a notification while checking |
| **Settings…**          | Opens the Settings panel (account info, API keys, billing)               |
| **Log Out**            | Signs you out and returns to the login screen                            |

## Settings

Open **Teak menu → Settings…** to manage your account:

- **Account**: View your email address and card count.
- **Upgrade / Billing**: Upgrade to Pro or open the customer portal to manage your subscription.
- **API Keys**: Generate API keys for the [Teak API](/docs/api) and [Raycast extension](/docs/raycast).
- **Import/Export Data**: [Import](/docs/import) bookmarks, a Raindrop CSV, or a Teak archive, and start, cancel, and download a portable [data export](/docs/export).
- **Appearance**: Switch between **Auto**, **Light**, and **Dark** themes. Auto follows your macOS system appearance.
- **Sign Out**: Ends your desktop session and returns to the login screen.
- **Delete Account**: Opens `app.teakvault.com/settings` in your browser to complete account deletion.

## Auto Updates

Teak checks for updates on each launch via GitHub Releases.

- If an update is available, you'll see a prompt asking whether to download now or later.
- During download, a macOS notification and a percent badge on the Dock icon show progress.
- After download completes, you'll see a prompt to restart now or later to install the update.
- If update checks fail (for example network outage), Teak continues running and retries on next launch.

## Manual Update / Recovery

If you need to update manually or recover from a failed install:

<Steps>

1. Quit Teak.

2. Download the latest release from [GitHub Releases](https://github.com/praveenjuge/teak/releases/latest).

3. Replace **Teak.app** in Applications.

4. Relaunch Teak.

</Steps>

## Rollback

If a release is unstable:

<Steps>

1. Download the prior stable release from GitHub Releases.

2. Replace **Teak.app** in Applications with that version.

3. Relaunch Teak.

</Steps>

Your account data stays in Teak backend storage and local session state is preserved unless you sign out.

## Troubleshooting

### App opens but cannot sign in

- Check network connectivity.
- Confirm your system clock is correct.
- Retry after a minute in case of temporary auth service issues.

### Update does not apply

- Relaunch the app and wait for update check.
- Confirm GitHub Releases is reachable from your network.
- If you are on a very old build that does not auto-update, install the latest release manually from GitHub.

### Still stuck?

Reach out via [Support](/docs/support).