María Craigandzed-zippy[bot]
e9f743d651
Audited the AI documentation against the implementation
## Changes
- **tool-permissions**: `skill` tool patterns match the absolute
`SKILL.md` path, not the skill name (fixed the table, example pattern,
and added a clarifying note).
- **external-agents**: Gemini CLI receives Zed's Google AI key when no
env key is set; extension-provided agents are deprecated in favor of the
ACP registry.
- **inline-assistant**: alternatives run alongside the inline assistant
model (not just the default model); fixed a broken anchor and
`gpt-4-mini` → `gpt-5-mini` model id typos.
- **mcp**: corrected the extensions menu item name ("Install New
Servers…"), the remote server `url` example, and removed the nonexistent
`thinking` tool from the profile example.
- **agent-panel**: "New From Summary" lives in the New Thread menu;
corrected the `@`-mention type list (no "instruction files"; added Fetch
and Branch Diff).
- **use-api-access**: DeepSeek default `api_url` includes `/v1`.
- **skills**: folder name is a convention not a requirement; long
descriptions warn rather than fail (measured in bytes); hidden skills
are also `@`-mentionable; dropped the unenforced consecutive-hyphen
rule; reconciled the no-remote-registry note with GitHub import.
- **edit-prediction**: `alt-tab` and `alt-l` are bound across platforms;
predictions are throttled rather than fired on every keystroke.
- **getting-started, windows-and-projects, parallel-agents**: Panel
Layout lives in the title-bar user menu, with
`workspace::UseAgenticLayout`/`UseClassicLayout` action references.
Release Notes:
- N/A
---------
Co-authored-by: zed-zippy[bot] <234243425+zed-zippy[bot]@users.noreply.github.com>
97 lines
4.2 KiB
Markdown
97 lines
4.2 KiB
Markdown
---
|
|
title: Getting Started with Zed
|
|
description: Get started with Zed, the fast open-source code editor. Essential commands, environment setup, and navigation basics.
|
|
---
|
|
|
|
# Getting Started
|
|
|
|
Zed is an open-source code editor with built-in collaboration and AI tools.
|
|
|
|
This guide covers the essential commands, environment setup, and navigation basics.
|
|
|
|
## Quick Start
|
|
|
|
### Welcome Page
|
|
|
|
When you open Zed without a folder, you see the welcome page in the main editor area. The welcome page offers quick actions to open a folder, clone a repository, or view documentation. Once you open a folder or file, the welcome page disappears. If you split the editor into multiple panes, the welcome page appears only in the center pane when empty—other panes show a standard empty state.
|
|
|
|
To reopen the welcome page, close all items in the center pane or use the command palette to search for "Welcome".
|
|
|
|
### 1. Open a Project
|
|
|
|
Open a folder from the command line:
|
|
|
|
```sh
|
|
zed ~/projects/my-app
|
|
```
|
|
|
|
Or use `Cmd+O` (macOS) / `Ctrl+O` (Linux/Windows) to open a folder from within Zed.
|
|
|
|
By default, new projects open in your current window's threads sidebar. To open in a new window instead, use `zed -n ~/projects/my-app` or press `Cmd+Enter` when selecting from Open Recent. See [Windows & Projects](./windows-and-projects.md) for more details.
|
|
|
|
### 2. Learn the Essential Commands
|
|
|
|
| Action | macOS | Linux/Windows |
|
|
| --------------- | ------------- | -------------- |
|
|
| Command palette | `Cmd+Shift+P` | `Ctrl+Shift+P` |
|
|
| Go to file | `Cmd+P` | `Ctrl+P` |
|
|
| Go to symbol | `Cmd+Shift+O` | `Ctrl+Shift+O` |
|
|
| Find in project | `Cmd+Shift+F` | `Ctrl+Shift+F` |
|
|
| Toggle terminal | `` Ctrl+` `` | `` Ctrl+` `` |
|
|
| Open settings | `Cmd+,` | `Ctrl+,` |
|
|
|
|
The command palette (`Cmd+Shift+P`) is your gateway to every action in Zed. If you forget a shortcut, search for it there.
|
|
|
|
### Panel Layout
|
|
|
|
Use **Panel Layout > Agentic** from the user menu in the title bar (or the {#action workspace::UseAgenticLayout} action) when you want the Agent Panel and Threads Sidebar next to each other on the left. Use **Panel Layout > Classic** (or {#action workspace::UseClassicLayout}) to restore the editor-oriented layout.
|
|
|
|
### 3. Configure Your Editor
|
|
|
|
Open the Settings Editor with `Cmd+,` (macOS) or `Ctrl+,` (Linux/Windows). Search for any setting and change it directly.
|
|
|
|
Common first changes:
|
|
|
|
- **Theme**: Press `Cmd+K Cmd+T` (macOS) or `Ctrl+K Ctrl+T` (Linux/Windows) to open the theme selector
|
|
- **Font**: Search for `buffer_font_family` in Settings
|
|
- **Format on save**: Search for `format_on_save` and set to `on`
|
|
|
|
### 4. Set Up Your Language
|
|
|
|
Zed includes built-in support for many languages. For others, install the extension:
|
|
|
|
1. Open Extensions with `Cmd+Shift+X` (macOS) or `Ctrl+Shift+X` (Linux/Windows)
|
|
2. Search for your language
|
|
3. Click Install
|
|
|
|
See [Languages](./languages.md) for language-specific setup instructions.
|
|
|
|
### 5. Try AI Features
|
|
|
|
Zed includes built-in AI assistance. Open the Agent Panel with `Cmd+Shift+A` (macOS) or `Ctrl+Shift+A` (Linux/Windows) to start a conversation, or use `Cmd+Enter` (macOS) / `Ctrl+Enter` (Linux/Windows) for inline assistance.
|
|
|
|
See [AI Overview](./ai/overview.md) to configure providers and learn what's possible.
|
|
|
|
## Coming from Another Editor?
|
|
|
|
We have dedicated guides for switching from other editors:
|
|
|
|
- [VS Code](./migrate/vs-code.md) — Import settings, map keybindings, find equivalent features
|
|
- [IntelliJ IDEA](./migrate/intellij.md) — Adapt to Zed's approach to navigation and refactoring
|
|
- [PyCharm](./migrate/pycharm.md) — Set up Python development in Zed
|
|
- [WebStorm](./migrate/webstorm.md) — Configure JavaScript/TypeScript workflows
|
|
- [RustRover](./migrate/rustrover.md) — Rust development in Zed
|
|
|
|
You can also enable familiar keybindings:
|
|
|
|
- **Vim**: Enable `vim_mode` in settings. See [Vim Mode](./vim.md).
|
|
- **Helix**: Enable `helix_mode` in settings. See [Helix Mode](./helix.md).
|
|
|
|
## Join the Community
|
|
|
|
Zed is open source. Join us on GitHub or in Discord to contribute code, report bugs, or suggest features.
|
|
|
|
- [Discord](https://discord.com/invite/zedindustries)
|
|
- [GitHub Discussions](https://github.com/zed-industries/zed/discussions)
|
|
- [Zed Reddit](https://www.reddit.com/r/ZedEditor)
|