Skip to content

Commit

Permalink
File Operations Documentation (#2005)
Browse files Browse the repository at this point in the history
Add docs for directory preview drag and drop to copy
Modify docs for the file operations to reflect new changes
  • Loading branch information
oneirocosm authored Feb 21, 2025
1 parent 1a90474 commit 9b4ca0f
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
4 changes: 4 additions & 0 deletions docs/docs/widgets.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,10 @@ When looking at a directory, preview will show a file viewer much like MacOS' _F

The simplest way to view a new file is to double click its row in the file viewer. Alternatively, while the widget is focused, you can use the <Kbd k="ArrowUp" /> and <Kbd k="ArrowDown" /> arrow keys to select a row and press enter to preview the associated file.

##### Copy a File

If you have two directory widgets open, you can copy a file or a directory between them. To do this, simply drag the file or directory from one directory preview widget to another that is opened to where you would like it dropped. This even works for copying files and directories across connections.

##### View the Parent Directory

In the directory view, this is as simple as opening the `..` file as if it were a regular file. This can be done with the method above. You can also use the keyboard shortcut <Kbd k="Cmd:ArrowUp"/>.
Expand Down
8 changes: 3 additions & 5 deletions docs/docs/wsh-reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -460,13 +460,13 @@ This allows setting various options in the `config/settings.json` file. It will
## file
The `file` command provides a set of subcommands for managing files across different storage systems, such as `wavefile`, `wsh` remote servers, and S3 (not yet supported).
The `file` command provides a set of subcommands for managing files across different storage systems, such as `wavefile`, `wsh` remote servers, and S3.
:::note
Wave Terminal is capable of managing files from remote SSH hosts, S3-compatible
systems, and the internal Wave filesystem. Files are addressed via URIs, which
vary depending on the storage system.
vary depending on the storage system. If no scheme is specified, the file will be treated as a local connection.
URI format: `[profile]:[uri-scheme]://[connection]/[path]`
Expand Down Expand Up @@ -509,8 +509,6 @@ Supported URI schemes:
- `wavefile://temp/...` - stored globally, but removed on startup/shutdown
- `wavefile://[uuid]/...` - an entity id (can be a block, tab, workspace, etc.)
All file operations respect a maximum file size of 10MB.
:::
### cat
Expand Down Expand Up @@ -545,7 +543,7 @@ cat config.json | wsh file write //ec2-user@remote01/~/config.json
wsh file append [file-uri]
```
Append data from stdin to a file, respecting the 10MB total file size limit. This is useful for log files or accumulating data. For example:
Append data from stdin to a file, respecting a 10MB total file size limit. This is useful for log files or accumulating data. For example:
```sh
tail -f app.log | wsh file append wavefile://block/logs.txt
Expand Down

0 comments on commit 9b4ca0f

Please sign in to comment.