Skip to content

Commit c1d1092

Browse files
Quick start section
Signed-off-by: Laurent Martin <laurent.martin.l@gmail.com>
1 parent a37400e commit c1d1092

1 file changed

Lines changed: 52 additions & 53 deletions

File tree

docs/README.erb.md

Lines changed: 52 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -109,11 +109,12 @@ The transfer is not directly implemented in <%=tool%>; rather, <%=tool%> uses on
109109
110110
## Quick Start
111111

112-
This section guides you from installation to first use and advanced use.
112+
This section walks you through installation, your first transfer, and next steps.
113113

114-
First, follow section: [Installation](#installation) (Ruby, Gem, FASP) to start using <%=tool%>.
114+
### Prerequisites
115115

116-
Once the gem is installed, <%=tool%> shall be accessible:
116+
Before continuing, complete the [Installation](#installation) section (Ruby, Gem, FASP) to get <%=tool%> set up on your system.
117+
Once installed, confirm <%=tool%> is accessible by checking its version:
117118

118119
```shell
119120
<%=cmd%> --version
@@ -124,20 +125,24 @@ Once the gem is installed, <%=tool%> shall be accessible:
124125
```
125126

126127
> [!NOTE]
127-
> All command line examples provided in sections named **<%=sample_commands_title(:_plugin_name_)%>** are tested during version validation.
128+
> All command line examples in sections titled **<%=sample_commands_title(:_plugin_name_)%>** are verified during version validation.
128129
129-
### First use
130+
### Option A - Test with the Aspera Demo Server
130131

131-
Once installation is completed, you can proceed to the first use with a demo server:
132+
- Run the following two commands to initialize the demo environment:
132133

133-
If you want to test with Aspera on Cloud, jump to section: [Wizard](#wizard).
134+
```shell
135+
<%=cmd%> config initdemo
136+
```
134137

135-
To test with Aspera demo transfer server, set up the environment and then test:
138+
- Check the configuration:
136139

137140
```shell
138-
<%=cmd%> config initdemo
141+
<%=cmd%> config preset overview
139142
```
140143

144+
- Browse the remote file system:
145+
141146
```shell
142147
<%=cmd%> server browse /
143148
```
@@ -153,75 +158,71 @@ To test with Aspera demo transfer server, set up the environment and then test:
153158
╰────────────┴──────┴───────────┴───────┴───────────────────────────┴───────────────────────╯
154159
```
155160

156-
If you want to use <%=tool%> with another server, and in order to make further calls more convenient, it is advised to define an [Option Preset](#option-preset) for the server's authentication options.
157-
The following example will:
158-
159-
- Create an [Option Preset](#option-preset)
160-
- Define it as default for the `server` plugin
161-
- List files in a folder
162-
- Download a file
161+
- Download a file:
163162

164163
```shell
165-
<%=cmd%> config preset update myserver --url=ssh://demo.asperasoft.com:33001 --username=asperaweb --password=my_password_here
164+
<%=cmd%> server download /aspera-test-dir-small/10MB.1
166165
```
167166

168167
```text
169-
Updated: myserver
170-
Saving config file.
168+
Time: 00:00:02 ====================================== 100% 100 Mbps Time: 00:00:00
169+
complete
171170
```
172171

172+
### Option B - Connecting to Your Own HSTS
173+
174+
To use <%=tool%> with a server of your own, it's recommended to save its connection details as an [Option Preset](#option-preset).
175+
This avoids repeating credentials on every command.
176+
The steps below create a preset, set it as the default for the server plugin, browse a remote directory, and download a file:
177+
178+
- Create a preset with your server's connection details:
179+
173180
```shell
174-
<%=cmd%> config preset set default server myserver
181+
<%=cmd%> config preset update myserver --url=ssh://demo.asperasoft.com:33001 --username=aspera --password=demoaspera
175182
```
176183

177184
```text
178-
Updated: default: server <- myserver
185+
Updated: myserver
179186
Saving config file.
180187
```
181188

189+
- Set the preset as the default for the server plugin:
190+
182191
```shell
183-
<%=cmd%> server browse /aspera-test-dir-large
192+
<%=cmd%> config preset set default server myserver
184193
```
185194

186195
```text
187-
╭────────────┬──────┬───────────┬─────────────┬───────────────────────────┬───────╮
188-
│ zmode │ zuid │ zgid │ size │ mtime │ name │
189-
╞════════════╪══════╪═══════════╪═════════════╪═══════════════════════════╪═══════╡
190-
│ -rw-r--r-- │ xfer │ demousers │ 5368709120 │ 2014-11-05 16:01:56 +0100 │ 5GB │
191-
│ -rw-r--r-- │ xfer │ demousers │ 524288000 │ 2014-11-05 16:01:56 +0100 │ 500MB │
192-
│ -rw-r--r-- │ xfer │ demousers │ 209715200 │ 2014-11-05 16:01:56 +0100 │ 200MB │
193-
│ -rw-r--r-- │ xfer │ demousers │ 1048576000 │ 2014-11-05 16:01:56 +0100 │ 1GB │
194-
│ -rw-r--r-- │ xfer │ demousers │ 104857600 │ 2014-11-05 16:01:56 +0100 │ 100MB │
195-
│ -rw-r--r-- │ xfer │ demousers │ 10737418240 │ 2014-11-05 16:01:56 +0100 │ 10GB │
196-
╰────────────┴──────┴───────────┴─────────────┴───────────────────────────┴───────╯
196+
Updated: default: server <- myserver
197+
Saving config file.
197198
```
198199

199-
```shell
200-
<%=cmd%> server download /aspera-test-dir-large/200MB
201-
```
200+
- Once your preset is set, follow the same browse and download steps as in [Option A](#option-a---test-with-the-aspera-demo-server).
202201

203-
```text
204-
Time: 00:00:02 ====================================== 100% 100 Mbps Time: 00:00:00
205-
complete
206-
```
202+
### Option C — Test with Aspera on Cloud
203+
204+
If you'd prefer to test against Aspera on Cloud, skip ahead to the [AoC Wizard](#aoc-configuration-using-wizard) section.
207205

208-
### Going further
206+
### Next Steps
209207

210-
Get familiar with configuration, options, and commands: [Command Line Interface](#command-line-interface).
208+
- Learn the CLI: Read [Command Line Interface](#command-line-interface) to understand configuration, options, and commands.
211209

212-
Then, follow the section relative to the product you want to interact with (Aspera on Cloud, Faspex, ...): [Application Plugins](#plugins)
210+
- Explore plugins: Jump to the section for the product you're working with Aspera on Cloud, Faspex, and more — under [Application Plugins](#plugins).
213211

214212
## Installation
215213

216214
There are several possibilities to install <%=tool%>:
217215

218-
- As a [single file executable](#single-file-executable),
219216
- Using a Ruby environment directly on the host operating system (Linux, macOS, Windows).
217+
220218
This is the most generic method.
221219
It consists in installing:
222220
- The [Ruby language](#ruby),
223221
- Then [<%=gemspec.name%>](#ruby-gem-aspera-cli) Ruby gem,<!-- markdownlint-disable-line -->
224222
- [Aspera Transfer Daemon (`ascp`)](#fasp-protocol-ascp).
223+
- As a [single file executable](#single-file-executable)
224+
225+
This is easy, but only a limited number of platforms is supported.
225226
- As a [container](#container) (`docker`, `podman`, `singularity`).
226227

227228
The following sections provide information on the various installation methods.
@@ -232,11 +233,9 @@ If you don't have internet for the installation, refer to section [Installation
232233
### Single file executable
233234

234235
> [!WARNING]
235-
> This is a Beta feature.
236236
> Only on a limited number of platforms.
237237
238-
<%=tool%> is available as a single **platform-dependent executable**.
239-
[Beta releases can be found here](https://ibm.biz/aspera-cli-exe).
238+
<%=tool%> is available as a single **platform-dependent executable** in the [Releases](https://github.com/IBM/aspera-cli/releases).
240239

241240
#### Installation
242241

@@ -733,7 +732,7 @@ Refer to section: [Transfer Agents](#transfer-clients-agents)
733732

734733
Necessary gems can be packed in a `tar.gz` like this:
735734

736-
```bash
735+
```shell
737736
mkdir temp_folder
738737
gem install <%=gemspec.name%>:<%=build_version%> --no-document --install-dir temp_folder
739738
find temp_folder
@@ -2139,7 +2138,7 @@ When a specific type is required for the value, the [Extended Value Syntax](#ext
21392138

21402139
Example: dot-path to JSON output
21412140

2142-
```bash
2141+
```shell
21432142
<%=cmd%> config echo @: a.b=1 a.c=2 a.d.0=hello a.d.1=world --format=json
21442143
```
21452144

@@ -2149,7 +2148,7 @@ Example: dot-path to JSON output
21492148

21502149
Example: JSON to dot-path output
21512150

2152-
```bash
2151+
```shell
21532152
ascli config echo @json:'{"a":{"b":1,"c":2,"d":["hello","world"]}}'
21542153
```
21552154

@@ -8022,26 +8021,26 @@ Below is a simple end‑to‑end procedure to verify synchronization using the d
80228021
80238022
1. Initialize the demo server configuration:
80248023
8025-
```bash
8024+
```shell
80268025
<%=cmd%> config initdemo
80278026
```
80288027
80298028
1. Create a local folder with a sample file to sync:
80308029
8031-
```bash
8030+
```shell
80328031
mkdir foobar
80338032
echo hello > foobar/file1
80348033
```
80358034
80368035
1. Create the destination folder on the remote server:
80378036
8038-
```bash
8037+
```shell
80398038
<%=cmd%> server -Pdemoserver mkdir /Upload/mydest1
80408039
```
80418040
80428041
1. Run the sync operation:
80438042
8044-
```bash
8043+
```shell
80458044
<%=cmd%> server -Pdemoserver sync push foobar --to-folder=/Upload/mydest1
80468045
```
80478046

0 commit comments

Comments
 (0)