aspera-cli 4.0.0.pre1 → 4.0.0.pre2

data/docs/Makefile

@@ -3,27 +3,29 @@
 
 DIR_TOP=../
 include $(DIR_TOP)common.make
+# "make" shall be executed inside the folder containing this makefile
 DIR_DOC=
 
 # files generated to be included in README.md
 INCL_USAGE=$(DIR_TMP)$(EXENAME)_usage.txt
 INCL_COMMANDS=$(DIR_TMP)$(EXENAME)_commands.txt
 INCL_ASESSION=$(DIR_TMP)asession_usage.txt
+INCL_TRSPEC=$(DIR_DOC)transfer_spec.html
+# env var used in README.erb.md
+export EXENAME GEMSPEC INCL_USAGE INCL_COMMANDS INCL_ASESSION INCL_TRSPEC
+
 TMPL_TEST_CONF=$(DIR_DOC)$(TEST_CONF_FILE_BASE)
-TMPL_SECRETS=$(DIR_DOC)$(SECRETS_FILE_NAME)
 
 MANUAL_BASE=$(DIR_DOC)Manual_$(EXENAME)_$(GEMVERSION)
 MANUAL_PDF=$(MANUAL_BASE).pdf
 MANUAL_HTML=$(MANUAL_BASE).html
 
 # main target to build doc
-all:: $(MANUAL_PDF) $(TMPL_SECRETS) $(TMPL_TEST_CONF)
+all:: $(MANUAL_PDF) $(TMPL_TEST_CONF)
 
 doc: all
 
-# generate template configuration files, remove own secrets
-$(TMPL_SECRETS): $(SECRETS_FILE_PATH)
-	sed 's/=.*/=_value_here_/' < $(SECRETS_FILE_PATH) > $(TMPL_SECRETS)
+# generate template configuration file for tests, remove own secrets
 $(TMPL_TEST_CONF): $(TEST_CONF_FILE_PATH)
 	ruby -e 'require "yaml";n={};c=YAML.load_file("$(TEST_CONF_FILE_PATH)").each{|k,v| n[k]=["config","default"].include?(k)?v:v.keys.inject({}){|m,i|m[i]="your value here";m}};File.write("$(TMPL_TEST_CONF)",n.to_yaml)'
 
@@ -31,21 +33,25 @@ $(MANUAL_PDF): $(DIR_TOP)README.md
 	pandoc --number-sections --resource-path=. --toc -o $(MANUAL_HTML) $(DIR_TOP)README.md
 	wkhtmltopdf toc $(MANUAL_HTML) $(MANUAL_PDF)
 
-$(DIR_TOP)README.md: $(DIR_DOC)README.erb.md $(INCL_COMMANDS) $(INCL_USAGE) $(INCL_ASESSION)
-	DIR_DOC=$(DIR_DOC) COMMANDS=$(INCL_COMMANDS) USAGE=$(INCL_USAGE) ASESSION=$(INCL_ASESSION) VERSION=`$(EXETESTB) -Cnone --version` TOOLNAME=$(EXENAME) erb $(DIR_DOC)README.erb.md > $(DIR_TOP)README.md
+$(DIR_TOP)README.md: $(DIR_DOC)README.erb.md $(DIR_DOC)transfer_spec.html $(INCL_COMMANDS) $(INCL_USAGE) $(INCL_ASESSION)
+	erb -T - --encoding UTF-8:UTF-8 $(DIR_DOC)README.erb.md > $(DIR_TOP)README.md
 
 $(INCL_COMMANDS): $(DIR_TMP).exists $(TEST_MAKEFILE)
 	sed -nEe 's/.*\$$\(EXE_MAN.?\)/$(EXENAME)/p' $(TEST_MAKEFILE) > $(DIR_TMP)usg1.txt
-	sed -i.bak -Ee 's/\$$\((DIR_[^)]+)\)/\1\//g' $(DIR_TMP)usg1.txt
+	sed -i.bak -Ee 's/\$$\$$\{([a-z_]+)\}/my_\1/g' $(DIR_TMP)usg1.txt
 	sed -i.bak -Ee 's/\$$\(([^)]+)\)/\1/g' $(DIR_TMP)usg1.txt
-	sed -i.bak -Ee 's/CF_([0-9A-Z_]*)/MY_\1/g' $(DIR_TMP)usg1.txt
 	sed -i.bak -Ee 's/\$$(\$$)/\1/g' $(DIR_TMP)usg1.txt
-	sed -i.bak -Ee 's/"'"'"'"\$${([a-z_]+)}"'"'"'"/"my_\1"/g' $(DIR_TMP)usg1.txt
-	sed -i.bak -Ee 's/="\$${([a-z_]+)}"/="my_\1"/g' $(DIR_TMP)usg1.txt
-	sed -i.bak -Ee 's/\$$@/xyz/g' $(DIR_TMP)usg1.txt
-	sed -i.bak -Ee 's/"'"'"'"/"/g' $(DIR_TMP)usg1.txt
+	sed -i.bak -Ee 's/\$$@/test/g' $(DIR_TMP)usg1.txt
 	sed -i.bak -Ee 's/"'"'"'/"/g' $(DIR_TMP)usg1.txt
 	sed -i.bak -Ee 's/'"'"'"/"/g' $(DIR_TMP)usg1.txt
+	sed -i.bak -Ee 's/""/"/g' $(DIR_TMP)usg1.txt
+	sed -i.bak -Ee 's/CF_//g' $(DIR_TMP)usg1.txt
+	sed -i.bak -Ee 's/DIR_[A-Z]+//g' $(DIR_TMP)usg1.txt
+	sed -i.bak -Ee 's/LOCAL_SAMPLE_FILE(NAME|PATH)/testfile.bin/g' $(DIR_TMP)usg1.txt
+	sed -i.bak -Ee 's/HSTS_FOLDER_UPLOAD/folder_1/g' $(DIR_TMP)usg1.txt
+	sed -i.bak -Ee 's/PKG_TEST_TITLE/Important files delivery/g' $(DIR_TMP)usg1.txt
+	sed -i.bak -Ee 's/AOC_EXTERNAL_EMAIL/external.user@example.com/g' $(DIR_TMP)usg1.txt
+	sed -i.bak -Ee 's/EMAIL_ADDR/internal.user@example.com/g' $(DIR_TMP)usg1.txt
 	sort -u < $(DIR_TMP)usg1.txt > $(INCL_COMMANDS)
 # generated help of tools depends on all sources, so regenerate always
 .PHONY: $(INCL_USAGE)

data/docs/README.erb.md

@@ -1,16 +1,30 @@
 [comment1]: # (Do not edit this README.md, edit docs/README.erb.md, for details, read docs/README.md)
-<%cmd=ENV["TOOLNAME"];tool='`'+cmd+'`';evp=cmd.upcase+'_';opprst='option preset';prst='['+opprst+'](#lprt)';prsts='['+opprst+'s](#lprt)';prstt=opprst.capitalize%>
-
+<%
+ # check that required env vars exist, and files
+%w{EXENAME GEMSPEC INCL_USAGE INCL_COMMANDS INCL_ASESSION INCL_TRSPEC}.each do |e|
+  raise "missing env var #{e}" unless ENV.has_key?(e)
+  raise "missing file #{ENV[e]}" unless File.exist?(ENV[e]) or !e.start_with?('INCL_') #_
+end
+cmd=ENV["EXENAME"] # just command name
+tool='`'+cmd+'`'   # used in text with formatting of command
+evp=cmd.upcase+'_' # prefix for env vars
+opprst='option preset' # just the name for "option preset"
+prst='['+opprst+'](#lprt)'
+prsts='['+opprst+'s](#lprt)'
+prstt=opprst.capitalize # in title
+gemspec=Gem::Specification::load(ENV["GEMSPEC"]) or raise "error loading #{ENV["GEMSPEC"]}"
+geminstadd=gemspec.version.to_s.match(/\.[^0-9]/)?' --pre':''
+-%>
 # <%=tool%> : a Command Line for IBM Aspera products
 
-Version : <%= ENV["VERSION"] %>
+Version : <%= gemspec.version.to_s %>
 
 _Laurent/2016-<%=Time.new.year%>_
 
 This gem provides a command line interface to Aspera Applications.
 
 Location (once released):
-[https://rubygems.org/gems/aspera-cli](https://rubygems.org/gems/aspera-cli)
+[<%= gemspec.metadata['rubygems_uri'] %>](<%= gemspec.metadata['rubygems_uri'] %>)
 
 Disclaimers:
 
@@ -38,7 +52,7 @@ Once the gem is installed, <%=tool%> shall be accessible:
 
 ```
 $ <%=cmd%> --version
-<%= ENV["VERSION"] %>
+<%= gemspec.version.to_s %>
 ```
 
 ## First use
@@ -106,7 +120,7 @@ Then, follow the section relative to the product you want to interact with ( Asp
 In order to use the tool or the gem, it is necessary to install those components:
 
 * [Ruby](#ruby)
-* [aspera-cli](#the_gem)
+* [<%= gemspec.name %>](#the_gem)
 * [FASP](#fasp_prot)
 
 The following sections provide information on the installation.
@@ -114,8 +128,7 @@ The following sections provide information on the installation.
 ## <a name="ruby"></a>Ruby
 
 A ruby interpreter is required to run the tool or to use the gem and tool.
-It is required to have privilege to install gems.
-Ruby 2.5+ is prefered, but it should also work with 2.1+.
+The Ruby version shall be <%= gemspec.required_ruby_version %>.
 Any type of Ruby installation can be used.
 
 Refer to the following sections for a proposed method for specific operating systems.
@@ -123,10 +136,10 @@ Refer to the following sections for a proposed method for specific operating sys
 ### macOS
 
 
-MacOS 10.13+ (High Sierra) comes with a recent Ruby, so you can use it directly, you will need to install aspera-cli using `sudo` :
+MacOS 10.13+ (High Sierra) comes with a recent Ruby, so you can use it directly, you will need to install <%= gemspec.name %> using `sudo` :
 
 ```
-$ sudo gem install aspera-cli
+$ sudo gem install <%= gemspec.name %><%=geminstadd%>
 ```
 
 Alternatively, if you use [Homebrew](https://brew.sh/) already you can install Ruby with it:
@@ -200,18 +213,18 @@ For instance to build from source, and install in `/opt/ruby` :
 # make install
 ```
 
-## <a name="the_gem"></a>`aspera-cli` gem
+## <a name="the_gem"></a>`<%= gemspec.name %>` gem
 
 Once you have Ruby and rights to install gems: Install the gem and its dependencies:
 
 ```
-# gem install aspera-cli
+# gem install <%= gemspec.name %><%=geminstadd%>
 ```
 
 To upgrade to the latest version:
 
 ```
-# gem update aspera-cli
+# gem update <%= gemspec.name %>
 ```
 
 ## <a name="fasp_prot"></a>FASP Protocol
@@ -222,7 +235,13 @@ an Aspera Transfer:
 * ascp
 * aspera-license (in same folder, or ../etc)
 
-Those can be found in one of IBM Asprea transfer server or client with its license file (some are free):
+This can be installed directly with
+
+```
+$ <%=cmd%> conf ascp install
+```
+
+Those can be found in one of IBM Aspera transfer server or client with its license file (some are free):
 
 * IBM Aspera Connect Client (Free)
 * IBM Aspera Desktop Client (Free)
@@ -241,7 +260,7 @@ other methods are available. Refer to section: [Transfer Agents](#agents)
 
 # <a name="cli"></a>Command Line Interface: <%=tool%>
 
-The `aspera-cli` Gem provides a command line interface (CLI) which interacts with Aspera Products (mostly using REST APIs):
+The `<%= gemspec.name %>` Gem provides a command line interface (CLI) which interacts with Aspera Products (mostly using REST APIs):
 
 * IBM Aspera High Speed Transfer Server (FASP and Node)
 * IBM Aspera on Cloud (including ATS)
@@ -385,7 +404,7 @@ The style of output can be set using the `format` parameter, supporting:
 Table output can be filtered using the `select` parameter. Example:
 
 ```
-$ <%=cmd%> aspera admin res user list --fields=name,email,ats_admin --query=@json:'{"per_page":1000,"page":1,"sort":"name"}' --select=@json:'{"ats_admin":true}'
+$ <%=cmd%> aoc admin res user list --fields=name,email,ats_admin --query=@json:'{"per_page":1000,"page":1,"sort":"name"}' --select=@json:'{"ats_admin":true}'
 :...............................:..................................:...........:
 :             name              :              email               : ats_admin :
 :...............................:..................................:...........:
@@ -988,7 +1007,7 @@ All standard _transfer-spec_ parameters can be overloaded. To display parameters
 run in debug mode (--log-level=debug). [_transfer-spec_](#transferspec) can
 also be saved/overridden in the config file.
 
-<%= File.read("#{ENV['DIR_DOC']}transfer_spec.html").gsub(/.*<body>(.*)<\/body>.*/m,'\1') %>
+<%= File.read(ENV['INCL_TRSPEC']).gsub(/.*<body>(.*)<\/body>.*/m,'\1') %>
 
 ### Destination folder for transfers
 
@@ -1134,7 +1153,7 @@ Usually the OS native scheduler shall already provide some sort of such protecti
 A non complete list of commands used in unit tests:
 
 ```
-<%= File.read(ENV["COMMANDS"]) %>
+<%= File.read(ENV["INCL_COMMANDS"]) %>
 ...and more
 ```
 
@@ -1142,7 +1161,7 @@ A non complete list of commands used in unit tests:
 
 ```
 $ <%=cmd%> -h
-<%= File.read(ENV["USAGE"]) %>
+<%= File.read(ENV["INCL_USAGE"]) %>
 
 ```
 
@@ -1182,7 +1201,7 @@ Preparing preset: aoc_myorg
 Please provide path to your private RSA key, or empty to generate one:
 option: pkeypath>
 using existing key:
-/Users/myself/.aspera/<%=cmd%>/aspera_on_cloud_key
+/Users/myself/.aspera/<%=cmd%>/aspera_aoc_key
 Using global client_id.
 option: username> john@example.com
 Updating profile with new key
@@ -1191,7 +1210,7 @@ Setting config preset as default for aspera
 saving config file
 Done.
 You can test with:
-$ <%=cmd%> aspera user info show
+$ <%=cmd%> aoc user info show
 ```
 
 Optionally, it is possible to create a new organization-specific "integration".
@@ -1319,13 +1338,13 @@ If you are not using the built-in client_id and secret, JWT needs to be authoriz
 * Using command line
 
 ```
-$ <%=cmd%> aspera admin res client list
+$ <%=cmd%> aoc admin res client list
 :............:.........:
 :     id     :  name   :
 :............:.........:
 : BJLPObQiFw : <%=cmd%> :
 :............:.........:
-$ <%=cmd%> aspera admin res client --id=BJLPObQiFw modify @json:'{"jwt_grant_enabled":true,"explicit_authorization_required":false}'
+$ <%=cmd%> aoc admin res client --id=BJLPObQiFw modify @json:'{"jwt_grant_enabled":true,"explicit_authorization_required":false}'
 modified
 ```
 
@@ -1346,14 +1365,14 @@ open the previously generated public key located here: `$HOME/.aspera/<%=cmd%>/a
 * Using command line
 
 ```
-$ <%=cmd%> aspera admin res user list
+$ <%=cmd%> aoc admin res user list
 :........:................:
 :   id   :      name      :
 :........:................:
 : 109952 : Tech Support   :
 : 109951 : LAURENT MARTIN :
 :........:................:
-$ <%=cmd%> aspera user info modify @ruby:'{"public_key"=>File.read(File.expand_path("~/.aspera/<%=cmd%>/aocapikey.pub"))}'
+$ <%=cmd%> aoc user info modify @ruby:'{"public_key"=>File.read(File.expand_path("~/.aspera/<%=cmd%>/aocapikey.pub"))}'
 modified
 ```
 
@@ -1383,7 +1402,7 @@ After this last step, commands do not require web login anymore.
 Once client has been registered and <%=prst%> created: <%=tool%> can be used:
 
 ```
-$ <%=cmd%> aspera files br /
+$ <%=cmd%> aoc files br /
 Current Workspace: Default Workspace (default)
 empty
 ```
@@ -1417,7 +1436,7 @@ In order to access some administrative actions on "nodes" (in fact, access keys)
 secret is required, it is usually provided using the `secret` option. For example in a command like:
 
 ```
-$ <%=cmd%> aspera admin res node --id="access_key1" --secret="secret1" v3 info
+$ <%=cmd%> aoc admin res node --id="access_key1" --secret="secret1" v3 info
 ```
 
 It is also possible to provide a set of secrets used on a regular basis. This can be done using the `secrets` option. The value provided shall be a Hash, where keys are access key ids, and values are the associated secrets.
@@ -1444,7 +1463,7 @@ A secret repository can always be selected at runtime using `--secrets=@preset:x
 * Bulk creation
 
 ```
-$ <%=cmd%> aspera admin res user create --bulk=yes @json:'[{"email":"dummyuser1@example.com"},{"email":"dummyuser2@example.com"}]'
+$ <%=cmd%> aoc admin res user create --bulk=yes @json:'[{"email":"dummyuser1@example.com"},{"email":"dummyuser2@example.com"}]'
 :.......:.........:
 :  id   : status  :
 :.......:.........:
@@ -1456,17 +1475,17 @@ $ <%=cmd%> aspera admin res user create --bulk=yes @json:'[{"email":"dummyuser1@
 * Find with filter and delete
 
 ```
-$ <%=cmd%> aspera admin res user list --query='@json:{"q":"dummyuser"}' --fields=id,email
+$ <%=cmd%> aoc admin res user list --query='@json:{"q":"dummyuser"}' --fields=id,email
 :.......:........................:
 :  id   :         email          :
 :.......:........................:
 : 98398 : dummyuser1@example.com :
 : 98399 : dummyuser2@example.com :
 :.......:........................:
-$ thelist=$(echo $(<%=cmd%> aspera admin res user list --query='@json:{"q":"dummyuser"}' --fields=id,email --field=id --format=csv)|tr ' ' ,)
+$ thelist=$(echo $(<%=cmd%> aoc admin res user list --query='@json:{"q":"dummyuser"}' --fields=id,email --field=id --format=csv)|tr ' ' ,)
 $ echo $thelist
 98398,98399
-$ <%=cmd%> aspera admin res user --bulk=yes --id=@json:[$thelist] delete
+$ <%=cmd%> aoc admin res user --bulk=yes --id=@json:[$thelist] delete
 :.......:.........:
 :  id   : status  :
 :.......:.........:
@@ -1478,7 +1497,7 @@ $ <%=cmd%> aspera admin res user --bulk=yes --id=@json:[$thelist] delete
 * Display current user's workspaces
 
 ```
-$ <%=cmd%> aspera user workspaces
+$ <%=cmd%> aoc user workspaces
 :......:............................:
 :  id  :            name            :
 :......:............................:
@@ -1493,13 +1512,13 @@ $ <%=cmd%> aspera user workspaces
 Creation of a sub-access key is like creation of access key with the following difference: authentication to node API is made with accesskey (master access key) and only the path parameter is provided: it is relative to the storage root of the master key. (id and secret are optional)
 
 ```
-$ <%=cmd%> aspera admin resource node --name=_node_name_ --secret=_secret_ v4 access_key create --value=@json:'{"storage":{"path":"/folder1"}}'
+$ <%=cmd%> aoc admin resource node --name=_node_name_ --secret=_secret_ v4 access_key create --value=@json:'{"storage":{"path":"/folder1"}}'
 ```
 
 * Display transfer events (ops/transfer)
 
 ```
-$ <%=cmd%> aspera admin res node --secret=_secret_ v3 transfer list --value=@json:'[["q","*"],["count",5]]'
+$ <%=cmd%> aoc admin res node --secret=_secret_ v3 transfer list --value=@json:'[["q","*"],["count",5]]'
 ```
 
               # page=1&per_page=10&q=type:(file_upload+OR+file_delete+OR+file_download+OR+file_rename+OR+folder_create+OR+folder_delete+OR+folder_share+OR+folder_share_via_public_link)&sort=-date
@@ -1517,13 +1536,13 @@ $ <%=cmd%> aspera admin res node --secret=_secret_ v3 transfer list --value=@jso
 * Display node events (events)
 
 ```
-$ <%=cmd%> aspera admin res node --secret=_secret_ v3 events
+$ <%=cmd%> aoc admin res node --secret=_secret_ v3 events
 ```
 
 * display members of a workspace
 
 ```
-$ <%=cmd%> aspera admin res workspace_membership list --fields=member_type,manager,member.email --query=@json:'{"page":1,"per_page":50,"embed":"member","inherited":false,"workspace_id":11363,"sort":"name"}'
+$ <%=cmd%> aoc admin res workspace_membership list --fields=member_type,manager,member.email --query=@json:'{"page":1,"per_page":50,"embed":"member","inherited":false,"workspace_id":11363,"sort":"name"}'
 :.............:.........:..................................:
 : member_type : manager :           member.email           :
 :.............:.........:..................................:
@@ -1548,20 +1567,20 @@ a- get id of first workspace
 
 ```
 WS1='First Workspace'
-WS1ID=$(<%=cmd%> aspera admin res workspace list --query=@json:'{"q":"'"$WS1"'"}' --select=@json:'{"name":"'"$WS1"'"}' --fields=id --format=csv)
+WS1ID=$(<%=cmd%> aoc admin res workspace list --query=@json:'{"q":"'"$WS1"'"}' --select=@json:'{"name":"'"$WS1"'"}' --fields=id --format=csv)
 ```
 
 b- get id of second workspace
 
 ```
 WS2='Second Workspace'
-WS2ID=$(<%=cmd%> aspera admin res workspace list --query=@json:'{"q":"'"$WS2"'"}' --select=@json:'{"name":"'"$WS2"'"}' --fields=id --format=csv)
+WS2ID=$(<%=cmd%> aoc admin res workspace list --query=@json:'{"q":"'"$WS2"'"}' --select=@json:'{"name":"'"$WS2"'"}' --fields=id --format=csv)
 ```
 
 c- extract membership information and change workspace id
 
 ```
-$ <%=cmd%> aspera admin res workspace_membership list --fields=manager,member_id,member_type,workspace_id --query=@json:'{"per_page":10000,"workspace_id":'"$WS1ID"'}' --format=jsonpp > ws1_members.json
+$ <%=cmd%> aoc admin res workspace_membership list --fields=manager,member_id,member_type,workspace_id --query=@json:'{"per_page":10000,"workspace_id":'"$WS1ID"'}' --format=jsonpp > ws1_members.json
 ```
 
 d- convert to creation data for second workspace:
@@ -1579,13 +1598,13 @@ jq '[.[] | {member_type,member_id,workspace_id,manager,workspace_id:"'"$WS2ID"'"
 e- add members to second workspace
 
 ```
-$ <%=cmd%> aspera admin res workspace_membership create --bulk=yes @json:@file:ws2_members.json
+$ <%=cmd%> aoc admin res workspace_membership create --bulk=yes @json:@file:ws2_members.json
 ```
 
 * get users who did not log since a date
 
 ```
-$ <%=cmd%> aspera admin res user list --fields=email --query=@json:'{"per_page":10000,"q":"last_login_at:<2018-05-28"}'
+$ <%=cmd%> aoc admin res user list --fields=email --query=@json:'{"per_page":10000,"q":"last_login_at:<2018-05-28"}'
 :...............................:
 :             email             :
 :...............................:
@@ -1597,7 +1616,7 @@ $ <%=cmd%> aspera admin res user list --fields=email --query=@json:'{"per_page":
 * list "Limited" users
 
 ```
-$ <%=cmd%> aspera admin res user list --fields=email --query=@json:'{"per_page":10000}' --select=@json:'{"member_of_any_workspace":false}'
+$ <%=cmd%> aoc admin res user list --fields=email --query=@json:'{"per_page":10000}' --select=@json:'{"member_of_any_workspace":false}'
 ```
 
 * Perform a multi Gbps transfer between two remote shared folders
@@ -1611,7 +1630,7 @@ $ <%=cmd%> conf wizard --url=https://sedemo.ibmaspera.com --username=laurent.mar
 Detected: Aspera on Cloud
 Preparing preset: aoc_sedemo
 Using existing key:
-/Users/laurent/.aspera/<%=cmd%>/aspera_on_cloud_key
+/Users/laurent/.aspera/<%=cmd%>/aspera_aoc_key
 Using global client_id.
 Please Login to your Aspera on Cloud instance.
 Navigate to your "Account Settings"
@@ -1626,7 +1645,7 @@ Setting config preset as default for aspera
 saving config file
 Done.
 You can test with:
-$ <%=cmd%> aspera user info show
+$ <%=cmd%> aoc user info show
 ```
 
 This creates the option preset "aoc_&lt;org name&gt;" to allow seamless command line access and sets it as default for aspera on cloud.
@@ -1641,14 +1660,14 @@ $ <%=cmd%> -Paoc_show aspera files transfer --from-folder='IBM Cloud SJ' --to-fo
 
 * create registration key to register a node
 ```
-$ <%=cmd%> aspera admin res admin/client create @json:'{"data":{"name":"laurentnode","client_subject_scopes":["alee","aejd"],"client_subject_enabled":true}}' --fields=token --format=csv
+$ <%=cmd%> aoc admin res admin/client create @json:'{"data":{"name":"laurentnode","client_subject_scopes":["alee","aejd"],"client_subject_enabled":true}}' --fields=token --format=csv
 jfqslfdjlfdjfhdjklqfhdkl
 ```
 
 * delete all registration keys
 
 ```
-$ <%=cmd%> aspera admin res admin/client list --fields=id --format=csv|<%=cmd%> aspera admin res admin/client delete --bulk=yes --id=@lines:@stdin:
+$ <%=cmd%> aoc admin res admin/client list --fields=id --format=csv|<%=cmd%> aoc admin res admin/client delete --bulk=yes --id=@lines:@stdin:
 +-----+---------+
 | id  | status  |
 +-----+---------+
@@ -1664,19 +1683,19 @@ $ <%=cmd%> aspera admin res admin/client list --fields=id --format=csv|<%=cmd%>
 * list shared folders in node
 
 ```
-$ <%=cmd%> aspera admin res node --id=8669 shared_folders
+$ <%=cmd%> aoc admin res node --id=8669 shared_folders
 ```
 
 * list shared folders in workspace
 
 ```
-$ <%=cmd%> aspera admin res workspace --id=10818 shared_folders
+$ <%=cmd%> aoc admin res workspace --id=10818 shared_folders
 ```
 
 * list members of shared folder
 
 ```
-$ <%=cmd%> aspera admin res node --id=8669 v4 perm 82 show
+$ <%=cmd%> aoc admin res node --id=8669 v4 perm 82 show
 ```
 
 ## Send a Package
@@ -1684,7 +1703,7 @@ $ <%=cmd%> aspera admin res node --id=8669 v4 perm 82 show
 Send a package:
 
 ```
-$ <%=cmd%> aspera packages send --value=@json:'{"name":"my title","note":"my note","recipients":["laurent.martin.aspera@fr.ibm.com","other@example.com"]}' --sources=@args my_file.dat
+$ <%=cmd%> aoc packages send --value=@json:'{"name":"my title","note":"my note","recipients":["laurent.martin.aspera@fr.ibm.com","other@example.com"]}' --sources=@args my_file.dat
 ```
 
 Notes:
@@ -1699,7 +1718,7 @@ Notes:
 It is possible to automatically download new packages, like using Aspera Cargo:
 
 ```
-$ <%=cmd%> aspera packages recv --id=ALL --once-only=yes --lock-port=12345
+$ <%=cmd%> aoc packages recv --id=ALL --once-only=yes --lock-port=12345
 ```
 
 * `--id=ALL` (case sensitive) will download all packages
@@ -1743,19 +1762,19 @@ f["type"].eql?("file") and (DateTime.now-DateTime.parse(f["modified_time"]))<100
 * expression to find files older than 1 year on a given node and store in file list
 
 ```
-$ <%=cmd%> aspera admin res node --name='my node name' --secret='my secret' v4 find / --fields=path --value='exec:f["type"].eql?("file") and (DateTime.now-DateTime.parse(f["modified_time"]))<100' --format=csv > my_file_list.txt
+$ <%=cmd%> aoc admin res node --name='my node name' --secret='my secret' v4 find / --fields=path --value='exec:f["type"].eql?("file") and (DateTime.now-DateTime.parse(f["modified_time"]))<100' --format=csv > my_file_list.txt
 ```
 
 * delete the files, one by one
 
 ```
-$ cat my_file_list.txt|while read path;do echo <%=cmd%> aspera admin res node --name='my node name' --secret='my secret' v4 delete "$path" ;done
+$ cat my_file_list.txt|while read path;do echo <%=cmd%> aoc admin res node --name='my node name' --secret='my secret' v4 delete "$path" ;done
 ```
 
 * delete the files in bulk
 
 ```
-cat my_file_list.txt | <%=cmd%> aspera admin res node --name='my node name' --secret='my secret' v3 delete @lines:@stdin:
+cat my_file_list.txt | <%=cmd%> aoc admin res node --name='my node name' --secret='my secret' v3 delete @lines:@stdin:
 ```
 
 ## Activity
@@ -1763,13 +1782,13 @@ cat my_file_list.txt | <%=cmd%> aspera admin res node --name='my node name' --se
 The activity app can be queried with:
 
 ```
-$ <%=cmd%> aspera admin analytics transfers
+$ <%=cmd%> aoc admin analytics transfers
 ```
 
 It can also support filters and send notification email with a template:
 
 ```
-$ <%=cmd%> aspera admin analytics transfers --once-only=yes --lock-port=123455 \
+$ <%=cmd%> aoc admin analytics transfers --once-only=yes --lock-port=123455 \
 --query=@json:'{"status":"completed","direction":"receive"}' \
 --notify=@json:'{"to":"<''%=transfer[:user_email.to_s]%>","subject":"<''%=transfer[:files_completed.to_s]%> files received","body":"Dear <''%=transfer[:user_email.to_s]%>\nWe received <''%=transfer[:files_completed.to_s]%> files for a total of <''%=transfer[:transferred_bytes.to_s]%> bytes, starting with file:\n<''%=transfer[:content.to_s]%>\n\nThank you."}'
 ```
@@ -1789,9 +1808,9 @@ By default transfer nodes are expected to use ports TCP/UDP 33001. The web UI en
 
 ATS is usable either :
 
-* from an AoC subscription : <%=cmd%> aspera admin ats
+* from an AoC subscription : <%=cmd%> aoc admin ats : use AoC authentication
 
-* or from an IBM Cloud subscription : <%=cmd%> ats
+* or from an IBM Cloud subscription : <%=cmd%> ats : use IBM Cloud API key authentication
 
 ## IBM Cloud ATS : creation of api key
 
@@ -1895,21 +1914,35 @@ $ <%=cmd%> server --ssh-keys=@list:,~/.ssh/id_rsa
 $ <%=cmd%> server --ssh-keys=@json:'["~/.ssh/id_rsa"]'
 ```
 
-The underlying ssh library `net::ssh` provides several options that may be used
-depending on environment. By default the ssh library expect that an ssh-agent is running, but if you get the error message:
+The underlying ssh library `net::ssh` provides several options that may be used depending on environment. By default the ssh library expect that an ssh-agent is running.
+
+If you get an error message such as:
 
 ```
+[Linux]
 ERROR -- net.ssh.authentication.agent: could not connect to ssh-agent: Agent not configured
 ```
 
-This means that you dont have such agent, check env var: `SSH_AGENT_SOCK`, check if the key is protected with a passphrase. [check the manual](https://net-ssh.github.io/ssh/v1/chapter-2.html#s2)
+or
+
+```
+[Windows]
+ERROR -- net.ssh.authentication.agent: could not connect to ssh-agent: pageant process not running
+```
+
+This means that you dont have such an ssh agent running:
 
-To diable use of `ssh-agent`, use the option `ssh_option` like this (or set in preset):
+* check env var: `SSH_AGENT_SOCK`
+* check if the key is protected with a passphrase
+* [check the manual](https://net-ssh.github.io/ssh/v1/chapter-2.html#s2)
+* To diable use of `ssh-agent`, use the option `ssh_option` like this (or set in preset):
 
 ```
 $ <%=cmd%> server --ssh-options=@ruby:'{use_agent: false}' ...
 ```
 
+This can also be set as default using a preset
+
 ## Example
 
 One can test the "server" application using the well known demo server:
@@ -2204,7 +2237,7 @@ To change this parameter in `aspera.conf`, use `asconfigurator`. To display the
 
 If you use a value different than 16777216, then specify it using option `max_size`.
 
-Note: the HSTS parameter (max_request_file_create_size_kb) is in kilobytes while the generator parameter is in bytes (factor of 1024).
+Note: the HSTS parameter (max_request_file_create_size_kb) is in *kiloBytes* while the generator parameter is in *Bytes* (factor of 1024).
 
 ## <a name="prev_ext"></a>External tools: Linux
 
@@ -2334,8 +2367,7 @@ using one of three overwrite method:
 
 Deletion of preview for deleted source files: not implemented yet.
 
-If the `scan` or `events` detection method is used, then the option : `skip_folders` can be used
-to skip some folders. It expects a list of path starting with slash, use the `@json:` notation, example:
+If the `scan` or `events` detection method is used, then the option : `skip_folders` can be used to skip some folders. It expects a list of path relative to the storage root (docroot) starting with slash, use the `@json:` notation, example:
 
 ```
 $ <%=cmd%> preview scan --skip-folders=@json:'["/not_here"]'
@@ -2343,14 +2375,14 @@ $ <%=cmd%> preview scan --skip-folders=@json:'["/not_here"]'
 
 The option `folder_reset_cache` forces the node service to refresh folder contents using various methods.
 
-## output preview Files types
+## Preview File types
 
 Two types of preview can be generated:
 
   * png: thumbnail
   * mp4: video preview (only for video)
 
-To skip generation of a format use option `skip_format`
+Use option `skip_format` to skip generation of a format.
 
 ## Supported input Files types
 
@@ -2508,7 +2540,7 @@ Nodejs: [https://www.npmjs.com/package/aspera](https://www.npmjs.com/package/asp
 
 ```
 $ asession -h
-<%= File.read(ENV["ASESSION"]) %>
+<%= File.read(ENV["INCL_ASESSION"]) %>
 ```
 
 # Hot folder
@@ -2606,15 +2638,16 @@ So, it evolved into <%=tool%>:
 
 # Release Notes
 
-* 4.0.0.pre1
+* 4.0.0.pre2
 
-        * now available as open source at [https://github.com/IBM/aspera-cli](https://github.com/IBM/aspera-cli) with general cleanup
-        * changed default tool name from `mlia` to `ascli`
-        * changed `aspera` command to `oncloud`
-        * changed gem name from `asperalm` to `aspera-cli`
-        * changed module name from `Asperalm` to `Aspera`
-        * removed command `folder` in `preview`, merged to `scan`
-        * persistency files go to sub folder instead of main folder
+	* now available as open source at [<%= gemspec.homepage %>](<%= gemspec.homepage %>) with general cleanup
+	* changed default tool name from `mlia` to `ascli`
+	* changed `aspera` command to `aoc`
+	* changed gem name from `asperalm` to `aspera-cli`
+	* changed module name from `Asperalm` to `Aspera`
+	* removed command `folder` in `preview`, merged to `scan`
+	* persistency files go to sub folder instead of main folder
+	* added possibility to install SDK: `config ascp install`
 
 * 0.11.8