cli: Instruct in --help how to run to see all logs (#24112)

Release Notes:

- N/A
This commit is contained in:
João Marcos 2025-02-03 04:46:49 -03:00 committed by GitHub
parent 52aed4849a
commit 08c834ced0
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -33,7 +33,19 @@ trait InstalledApp {
#[command(
name = "zed",
disable_version_flag = true,
after_help = "To read from stdin, append '-' (e.g. 'ps axf | zed -')"
before_help = "The Zed CLI binary.
This CLI is a separate binary that invokes Zed.
Examples:
`zed`
Simply opens Zed
`zed --foreground`
Runs in foreground (shows all logs)
`zed path-to-your-project`
Open your project in Zed
`zed -n path-to-file `
Open file/folder in a new window",
after_help = "To read from stdin, append '-', e.g. 'ps axf | zed -'"
)]
struct Args {
/// Wait for all of the given paths to be opened/closed before exiting.
@ -45,10 +57,9 @@ struct Args {
/// Create a new workspace
#[arg(short, long, overrides_with = "add")]
new: bool,
/// A sequence of space-separated paths that you want to open.
/// The paths to open in Zed (space-separated).
///
/// Use `path:line:row` syntax to open a file at a specific location.
/// Non-existing paths and directories will ignore `:line:row` suffix.
/// Use `path:line:column` syntax to open a file at the given line and column.
paths_with_position: Vec<String>,
/// Print Zed's version and the app path.
#[arg(short, long)]