From 0de5645f60968331651e179795266cf00cad3c3e Mon Sep 17 00:00:00 2001 From: Sylvia Crowe Date: Thu, 20 Feb 2025 14:43:04 -0800 Subject: [PATCH 1/5] docs: add drag and drop explainer --- docs/docs/widgets.mdx | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/docs/widgets.mdx b/docs/docs/widgets.mdx index 1b8162d10e..9a83f75855 100644 --- a/docs/docs/widgets.mdx +++ b/docs/docs/widgets.mdx @@ -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 and 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 . From bce8716df777bc6ad90d68cb3aa3aec8235b9d76 Mon Sep 17 00:00:00 2001 From: Sylvia Crowe Date: Thu, 20 Feb 2025 14:43:37 -0800 Subject: [PATCH 2/5] docs: add small descriptions of wsh file ops --- docs/docs/wsh-reference.mdx | 68 +++++++++++++++++++++++++++++++++++-- 1 file changed, 66 insertions(+), 2 deletions(-) diff --git a/docs/docs/wsh-reference.mdx b/docs/docs/wsh-reference.mdx index 49dbd2fa5d..14bbfbaa40 100644 --- a/docs/docs/wsh-reference.mdx +++ b/docs/docs/wsh-reference.mdx @@ -460,13 +460,77 @@ 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. + +### ls + +```sh +wsh file ls +``` + +List files in a directory. + +### cat + +```sh +wsh file cat +``` + +Display the contents of a file. + +### info + +```sh +wsh file info +``` + +Show information about a file. + +### rm + +```sh +wsh file rm +``` + +Remove a file. + +### write + +```sh +wsh file write +``` + +Write stdin into a file, buffering input (10MB total file size limit). + +### append + +```sh +wsh file append +``` + +Append stdin to a file, buffering input (10MB total file size limit). + +### cp + +```sh +wsh file cp +``` + +Copy files between different storage systems. + +### mv + +```sh +wsh file mv +``` + +Move files between different storage systems. The source file will be deleted once the operation completes successfully. :::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]` From dbef8a2b56acd28899a61129848bd9effd6c4c84 Mon Sep 17 00:00:00 2001 From: Sylvia Crowe Date: Thu, 20 Feb 2025 19:22:41 -0800 Subject: [PATCH 3/5] docs: more detail in file info and file rm --- docs/docs/wsh-reference.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs/wsh-reference.mdx b/docs/docs/wsh-reference.mdx index 14bbfbaa40..d861aa7863 100644 --- a/docs/docs/wsh-reference.mdx +++ b/docs/docs/wsh-reference.mdx @@ -484,7 +484,7 @@ Display the contents of a file. wsh file info ``` -Show information about a file. +Show information about a file. This includes the name, mode (permissions), mtime (last modified time), and size (file size in bytes). ### rm @@ -492,7 +492,7 @@ Show information about a file. wsh file rm ``` -Remove a file. +Remove a file. This is a permanent removal that acts much the same way as `rm`. Recovery is only possible by using a method that would work with the `rm` command. ### write From f91ea1dbba690ff2134a3e4f13555c875d99e0c4 Mon Sep 17 00:00:00 2001 From: Sylvia Crowe Date: Thu, 20 Feb 2025 19:54:15 -0800 Subject: [PATCH 4/5] docs: remove 10 mb max mention for all ops Only certain operations have the 10mb limit now, so this can be removed. --- docs/docs/wsh-reference.mdx | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/docs/wsh-reference.mdx b/docs/docs/wsh-reference.mdx index d861aa7863..e3c4ed7bbc 100644 --- a/docs/docs/wsh-reference.mdx +++ b/docs/docs/wsh-reference.mdx @@ -573,8 +573,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 From 19903fb0bca2c083ccba55ff4e2c4348dccecc97 Mon Sep 17 00:00:00 2001 From: Sylvia Crowe Date: Fri, 21 Feb 2025 12:05:28 -0800 Subject: [PATCH 5/5] docs: remove redundant file commands --- docs/docs/wsh-reference.mdx | 66 +------------------------------------ 1 file changed, 1 insertion(+), 65 deletions(-) diff --git a/docs/docs/wsh-reference.mdx b/docs/docs/wsh-reference.mdx index e3c4ed7bbc..18eacc106a 100644 --- a/docs/docs/wsh-reference.mdx +++ b/docs/docs/wsh-reference.mdx @@ -462,70 +462,6 @@ This allows setting various options in the `config/settings.json` file. It will The `file` command provides a set of subcommands for managing files across different storage systems, such as `wavefile`, `wsh` remote servers, and S3. -### ls - -```sh -wsh file ls -``` - -List files in a directory. - -### cat - -```sh -wsh file cat -``` - -Display the contents of a file. - -### info - -```sh -wsh file info -``` - -Show information about a file. This includes the name, mode (permissions), mtime (last modified time), and size (file size in bytes). - -### rm - -```sh -wsh file rm -``` - -Remove a file. This is a permanent removal that acts much the same way as `rm`. Recovery is only possible by using a method that would work with the `rm` command. - -### write - -```sh -wsh file write -``` - -Write stdin into a file, buffering input (10MB total file size limit). - -### append - -```sh -wsh file append -``` - -Append stdin to a file, buffering input (10MB total file size limit). - -### cp - -```sh -wsh file cp -``` - -Copy files between different storage systems. - -### mv - -```sh -wsh file mv -``` - -Move files between different storage systems. The source file will be deleted once the operation completes successfully. - :::note Wave Terminal is capable of managing files from remote SSH hosts, S3-compatible @@ -607,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