Skip to content

Commit 286783f

Browse files
authored
Adjust wsh file help text so it's 80 cols max width (#1795)
1 parent b0ee995 commit 286783f

1 file changed

Lines changed: 23 additions & 9 deletions

File tree

cmd/wsh/cmd/wshcmd-file.go

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -40,20 +40,30 @@ URI format: [profile]:[uri-scheme]://[connection]/[path]
4040
4141
Supported URI schemes:
4242
wsh:
43-
Used to access files on remote hosts over SSH via the WSH helper. Allows for file streaming to Wave and other remotes.
44-
Profiles are optional for WSH URIs, provided that you have configured the remote host in your "connections.json" or "~/.ssh/config" file.
45-
If a profile is provided, it must be defined in "profiles.json" in the Wave configuration directory.
43+
Used to access files on remote hosts over SSH via the WSH helper. Allows
44+
for file streaming to Wave and other remotes.
45+
46+
Profiles are optional for WSH URIs, provided that you have configured the
47+
remote host in your "connections.json" or "~/.ssh/config" file.
48+
49+
If a profile is provided, it must be defined in "profiles.json" in the Wave
50+
configuration directory.
4651
4752
Format: wsh://[remote]/[path]
4853
4954
Shorthands can be used for the current remote and your local computer:
5055
[path] a relative or absolute path on the current remote
5156
//[remote]/[path] a path on a remote
52-
/~/[path] a path relative to your home directory on your local computer
57+
/~/[path] a path relative to the home directory on your local
58+
computer
5359
s3:
5460
Used to access files on S3-compatible systems.
55-
Requires S3 credentials to be set up, either in the AWS CLI configuration files, or in "profiles.json" in the Wave configuration directory.
56-
If no profile is provided, the default from your AWS CLI configuration will be used. Profiles from the AWS CLI must be prefixed with "aws:".
61+
62+
Requires S3 credentials to be set up, either in the AWS CLI configuration
63+
files, or in "profiles.json" in the Wave configuration directory.
64+
65+
If no profile is provided, the default from your AWS CLI configuration will
66+
be used. Profiles from the AWS CLI must be prefixed with "aws:".
5767
5868
Format: s3://[bucket]/[path]
5969
aws:[profile]:s3://[bucket]/[path]
@@ -67,7 +77,11 @@ Supported URI schemes:
6777
var fileCmd = &cobra.Command{
6878
Use: "file",
6979
Short: "manage files across different storage systems",
70-
Long: "Manage files across different storage systems.\n\nWave Terminal is capable of managing files from remote SSH hosts, S3-compatible systems, and the internal Wave filesystem.\nFiles are addressed via URIs, which vary depending on the storage system." + UriHelpText}
80+
Long: `Manage files across different storage systems.
81+
82+
Wave Terminal is capable of managing files from remote SSH hosts, S3-compatible
83+
systems, and the internal Wave filesystem. Files are addressed via URIs, which
84+
vary depending on the storage system.` + UriHelpText}
7185

7286
var fileTimeout int
7387

@@ -139,7 +153,7 @@ var fileRmCmd = &cobra.Command{
139153
var fileWriteCmd = &cobra.Command{
140154
Use: "write [uri]",
141155
Short: "write stdin into a file (up to 10MB)",
142-
Long: "Write stdin into a file, buffering input and respecting 10MB total file size limit." + UriHelpText,
156+
Long: "Write stdin into a file, buffering input (10MB total file size limit)." + UriHelpText,
143157
Example: " echo 'hello' | wsh file write wavefile://block/greeting.txt",
144158
Args: cobra.ExactArgs(1),
145159
RunE: activityWrap("file", fileWriteRun),
@@ -149,7 +163,7 @@ var fileWriteCmd = &cobra.Command{
149163
var fileAppendCmd = &cobra.Command{
150164
Use: "append [uri]",
151165
Short: "append stdin to a file",
152-
Long: "Append stdin to a file, buffering input and respecting 10MB total file size limit." + UriHelpText,
166+
Long: "Append stdin to a file, buffering input (10MB total file size limit)." + UriHelpText,
153167
Example: " tail -f log.txt | wsh file append wavefile://block/app.log",
154168
Args: cobra.ExactArgs(1),
155169
RunE: activityWrap("file", fileAppendRun),

0 commit comments

Comments
 (0)