Skip to content

cli: correct fs help and learn.md #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mgasner wants to merge 1 commit into from
Closed

cli: correct fs help and learn.md #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions crates/cli/src/cli.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1934,7 +1934,7 @@ pub enum FsCommand {
/// --json, emits one NDJSON event per record (`upsert`, `delete`,
/// `move`, plus `reset`/`sync` staging markers and `synced`/`closed`).
Sync {
/// Path on the server (absolute, or relative to the server's cwd)
/// Path on the server (absolute, or relative to the client's cwd)
path: String,

/// Sync file contents too (hashes always sync)
Expand Down Expand Up @@ -2142,12 +2142,13 @@ pub enum FsCommand {
#[arg(short = 'w', long)]
word: bool,

/// Search gitignored files too; they rank after tracked ones.
/// Much slower on a tree with build output.
/// Search gitignored files and `.git` too. Results stay in path
/// order; ignored files are marked in --json. Much slower on a tree
/// with build output.
#[arg(long)]
no_ignore: bool,

/// Stop after this many matching files (0 = server default)
/// Stop after this many matching files (0 = no limit)
#[arg(short = 'm', long, default_value_t = 0)]
max_matches: u16,

Expand Down
12 changes: 7 additions & 5 deletions crates/cli/src/learn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,13 +268,15 @@ yas fs grep needle # search contents, PATH:LINE:TEXT
yas fs grep -e 'fn \w+' --root crates # regex
yas fs grep -sw Config # case-sensitive, whole word
yas fs grep -l needle # matching paths only
yas fs grep -m 3 needle # stop after three matching files
yas fs grep --no-ignore TODO # include gitignored files
yas fs sync . --json # mirror a tree, stream changes
```

`fs grep` is case-insensitive literal by default and honours `.gitignore`,
which is what keeps it fast on a tree with build output — `--no-ignore`
searches ignored files too and ranks them last. It exits 1 when nothing
`fs grep` is case-insensitive literal by default, honours `.gitignore`, and
skips `.git`, which is what keeps it fast on a tree with build output. Dotfiles
are searched. `--no-ignore` searches ignored files and `.git` too; results
stay in path order, with ignored files marked `"ignored": true` in `--json`. It exits 1 when nothing
matched, like grep(1), so `if yas fs grep -l TODO; then …` works.

Writes are compare-and-swap by default, so a concurrent change is a
Expand All @@ -284,9 +286,9 @@ conflict rather than a silent clobber (exit 1):
echo hi | yas fs write notes.txt # unconditional overwrite
echo hi | yas fs write notes.txt --create # fail if it exists
echo hi | yas fs write notes.txt --if-hash H # only if unchanged
yas fs mkdir -p a/b # create a directory
yas fs mkdir --parents a/b # create a directory and its parents
yas fs mv old new # rename or move
yas fs rm -r dir # remove a subtree
yas fs rm dir # remove a file or a whole subtree
yas fs ln -s target link # symlink (omit -s for a hard link)
```

Expand Down
Loading