https://github.com/sameerjs6/zed-cli-win-unofficial
Unofficial CLI for launching and managing Zed on Windows. Built in Go.
https://github.com/sameerjs6/zed-cli-win-unofficial
cli golang zed zed-editor zed-industries zed-windows
Last synced: 8 months ago
JSON representation
Unofficial CLI for launching and managing Zed on Windows. Built in Go.
- Host: GitHub
- URL: https://github.com/sameerjs6/zed-cli-win-unofficial
- Owner: SameerJS6
- License: mit
- Created: 2025-05-23T18:51:26.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-06-14T13:00:24.000Z (11 months ago)
- Last Synced: 2025-06-14T13:30:03.072Z (11 months ago)
- Topics: cli, golang, zed, zed-editor, zed-industries, zed-windows
- Language: Go
- Homepage: https://zedcli.sameerjs.com
- Size: 514 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
## Zed CLI For Windows (Unofficial)
This project is an unofficial Windows CLI for Zed (built from source). It provides all basic features:
- Launching Zed (`zed`)
- Launching & Managing mulitple instance of zed
- Opening directories or projects with `zed `
- Adding an 'Open with Zed' context menu integration.
## Table of Content
- [Usage](#usage)
- [Features & Behavior](#features--behavior)
- [Auto-Directory Creation](#auto-directory-creation)
- [Single Instance Limitation (Zed versions below v0.177.0)](#single-instance-limitation-zed-versions-below-v01770)
- [Installation](#installation)
- [Native Installation Scripts](#native-installation-scripts)
- [Scoop](#scoop)
- [Chocolatey (Coming Soon)](#chocolatey-coming-soon)
- [Manual (GitHub Release)](#manual-github-release)
- [Disclaimer & Affiliation](#disclaimer--affiliation)
- [License](#license)
## Usage
| Command | Description | Example |
| ----------------------- | ------------------------------------ | --------------------------------- |
| `zed` | Open Zed with last project | `zed` |
| `zed .` | Open current directory | `zed .` |
| `zed ` | Open specific file or directory | `zed C:\projects\my-app` |
| `zed config get` | Get current Zed executable path | `zed config get` |
| `zed config set ` | Set Zed executable path | `zed config set "C:\Zed\zed.exe"` |
| `zed context install` | Install "Open with Zed" context menu | `zed context install` |
| `zed context uninstall` | Remove "Open with Zed" context menu | `zed context uninstall` |
> [!NOTE]
> Use `zed context install` to add "Open with Zed" to your Windows context menu for easy right-click access. By default, it's not installed.
## Features & Behavior
### Auto-Directory Creation
When opening a non-existent path, the CLI automatically creates the required directories before launching Zed:
```bash
zed D:\projects\monkeypress
```
In this example, if `monkeypress` doesn't exist but `D:\projects\` does, the CLI will:
1. Create the `monkeypress` directory under `D:\projects\`
2. Open the newly created directory in Zed
### Single Instance Limitation (Zed versions below v0.177.0)
**Important:** This CLI cannot open multiple Zed windows if Zed is already running — but only when using Zed versions below `v0.177.0`. This limitation exists because:
- The CLI is unofficial and not integrated with Zed’s internal systems
- It does not have access to Zed’s IPC (Inter-Process Communication), which handles multi-instance support in official workflows
If you're using an older version and attempt to open a new project while Zed is running, the CLI will notify you about this limitation.
> [!NOTE]
> This limitation does not apply to Zed versions v0.177.0 and above.
## Installation
Recommended installation methods in order of preference:
1. [Native Installation Scripts](#native-installation-scripts)
2. [Scoop](#scoop)
3. [Chocolatey (Coming Soon)](#chocolatey-coming-soon)
4. [Manual (GitHub Release)](#manual-github-release)
### Native Installation Scripts
Running the native PowerShell scripts will handle everything related to setting up environment variables on your system.
#### Install CLI
Download and run the installation script for the Unofficial Zed CLI:
```powershell
irm https://raw.githubusercontent.com/SameerJS6/zed-cli-win-unofficial/refs/heads/main/scripts/release/install-wrapper.ps1 | iex
```
#### Install Zed + CLI (All-in-One)
Install both Zed (Unofficial Build) and the Unofficial CLI with zero setup. This script handles everything automatically:
```powershell
irm https://raw.githubusercontent.com/SameerJS6/zed-cli-win-unofficial/refs/heads/main/scripts/release/install-with-zed-wrapper.ps1 | iex
```
> [!NOTE]
> Installing via this method will place Zed and the Unofficial Zed CLI in their default directories.
>
> #### Zed
>
> ```powershell
> %LOCALAPPDATA%\Programs\Zed
> ```
>
> #### Unofficial Zed CLI
>
> ```powershell
> %LOCALAPPDATA%\zed-cli-win-unofficial
> ```
### Scoop
Install using [Scoop](https://scoop.sh/) for easy updates and management:
#### 1. Add the bucket
```powershell
scoop bucket add zed-cli-unofficial https://github.com/SameerJS6/zed-cli-win-unofficial
```
#### 2. Install the CLI
```powershell
scoop install zed-cli-unofficial/zed-cli-win-unofficial
```
✅ That’s it! You can now launch and use zed from any terminal window.
> [!TIP]
> If you don't have **Scoop** installed, run the following commands in **PowerShell** to install it:
>
> ```powershell
> Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
> Invoke-RestMethod -Uri https://get.scoop.sh | Invoke-Expression
> ```
### Chocolatey (Coming Soon)
> A Chocolatey package for zed-cli-win-unofficial is coming soon.
### Manual (GitHub Release)
Download and install manually from the GitHub releases page:
1. Visit the [Releases page](https://github.com/SameerJS6/zed-cli-win-unofficial/releases).
2. Download the `windows-x86_64.zip` asset.
3. Extract to a folder of your choosing (default: `%LOCALAPPDATA%\zed-cli-win-unofficial`).
4. Update your user `PATH` to include that folder (choose one method below):
PowerShell (CLI)
```powershell
$path = "$env:LOCALAPPDATA\zed-cli-win-unofficial"
[Environment]::SetEnvironmentVariable('PATH', $env:PATH + ';' + $path, 'User')
```
GUI
- Press Win, type "Environment Variables", and open "Edit user environment variables".
- Go `Advanced` tab and click on `Environment Variables`, now a pop up will appear.
- Under "User variables", select "Path" → click "Edit" → click "New".
- Paste `%LOCALAPPDATA%\zed-cli-win-unofficial` and click "OK" on all dialogs.
> If you have PowerToys installed, you can use the PowerToys _Environment Variables_ tool to manage your variables more easily.
Common Pitfalls
- Unblock the downloaded ZIP if prompted (Right-click → Properties → Unblock).
- Verify both `zed-cli-win-unofficial.exe` and `zed.bat` are present.
- Restart your terminal after updating the `PATH`.
## Disclaimer & Affiliation
This project is an unofficial Windows CLI launcher for [Zed](https://zed.dev). It is not affiliated with or endorsed by the Zed team.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.