Document zed CLI (#32879)

Kirill Bulatov created

Closes https://github.com/zed-industries/zed/issues/32646

Release Notes:

- N/A

Change summary

docs/src/getting-started.md | 19 +++++++++++++++++++
1 file changed, 19 insertions(+)

Detailed changes

docs/src/getting-started.md 🔗

@@ -50,6 +50,25 @@ Try it! Open the Command Palette and type in `new file`. You should see the list
 
 Any time you see instructions that include commands of the form `zed: ...` or `editor: ...` and so on that means you need to execute them in the Command Palette.
 
+## CLI
+
+Zed has a CLI, on Linux this should come with the distribution's Zed package (binary name can vary from distribution to distribution, `zed` will be used later for brevity).
+For macOS, the CLI comes in the same package with the editor binary, and could be installed into the system with the `cli: install` Zed command which will create a symlink to the `/usr/local/bin/zed`.
+It can also be built from source out of the `cli` crate in this repository.
+
+Use `zed --help` to see the full list of capabilities.
+General highlights:
+
+- Opening another empty Zed window: `zed`
+
+- Opening a file or directory in Zed: `zed /path/to/entry` (use `-n` to open in the new window)
+
+- Reading from stdin: `ps axf | zed -`
+
+- Starting Zed with logs in the terminal: `zed --foreground`
+
+- Uninstalling Zed and all its related files: `zed --uninstall`
+
 ## Configure Zed
 
 To open your custom settings to set things like fonts, formatting settings, per-language settings, and more, use the {#kb zed::OpenSettings} keybinding.