aspera-cli 4.25.0.pre2 → 4.25.0

data/README.md

@@ -2,7 +2,7 @@
 <!--
 DO NOT EDIT: THIS FILE IS GENERATED, edit docs/README.erb.md, for details, read docs/README.md
 PANDOC_META_BEGIN
-subtitle: "ascli 4.25.0.beta2"
+subtitle: "ascli 4.25.0"
 author: "Laurent MARTIN"
 PANDOC_META_END
 -->
@@ -42,7 +42,7 @@ Need to debug? I’ll show you what’s going on under the hood.
 
 Think of me as Aspera’s command-line sidekick: quick, reliable, and a little no-nonsense. You bring the files; I’ll bring the horsepower."
 
-Version : 4.25.0.beta2
+Version : 4.25.0
 
 Laurent/2016-2026
 
@@ -139,7 +139,7 @@ ascli --version
 ```
 
 ```text
-4.25.0.beta2
+4.25.0
 ```
 
 > [!NOTE]
@@ -592,33 +592,57 @@ Those are not installed as part of dependencies because they involve compilation
 See [Gemfile](Gemfile):
 
 | name | version | comment |
-|----------------------|---------|-----------------------------------------------------|
+|----------------------|----------|-----------------------------------------------------|
 | grpc | ~> 1.71 | (no jruby) for Aspera Transfer Daemon |
 | marcel | ~> 1.1 | for preview |
-| rmagick | ~> 6.1 | (no jruby) for terminal view |
 | symmetric-encryption | ~> 4.6 | for encrypted hash file secrets |
 | bigdecimal | ~> 3.1 | if RUBY_VERSION >= '3.4' for symmetric-encryption ? |
+| base64 | ~> 0.3 | if RUBY_VERSION >= '3.4' remove from standard gems |
 | sqlite3 | ~> 2.7 | (no jruby) for async DB |
 | jdbc-sqlite3 | ~> 3.46 | (jruby) for async DB |
 | sequel | ~> 5.96 | (jruby) for async DB |
 | ed25519 | ~> 1.4 | (no jruby) for ed25519 and OpenSSH file format |
 | bcrypt_pbkdf | ~> 1.1 | (no jruby) for ed25519 and OpenSSH file format |
 | syslog | ~> 0.3 | (no jruby) for logger=syslog |
+| rmagick | ~> 6.1 | (no jruby) for terminal view |
+| debug | ~> 1.11 | (no jruby) |
+| grpc-tools | ~> 1.67 |  |
+| rake | ~> 13.0 |  |
+| reek | ~> 6.5.0 |  |
+| rspec | ~> 3.0 |  |
+| rubocop | ~> 1.75 |  |
+| rubocop-ast | ~> 1.4 |  |
+| rubocop-performance | ~> 1.10 | (no jruby) |
+| rubocop-shopify | ~> 2.0 |  |
+| simplecov | ~> 0.22 |  |
+| solargraph | ~> 0.48 | (no jruby) |
 
 Install like this:
 
 ```shell
 gem install grpc -v '~> 1.71'
 gem install marcel -v '~> 1.1'
-gem install rmagick -v '~> 6.1'
 gem install symmetric-encryption -v '~> 4.6'
 gem install bigdecimal -v '~> 3.1'
+gem install base64 -v '~> 0.3'
 gem install sqlite3 -v '~> 2.7'
 gem install jdbc-sqlite3 -v '~> 3.46'
 gem install sequel -v '~> 5.96'
 gem install ed25519 -v '~> 1.4'
 gem install bcrypt_pbkdf -v '~> 1.1'
 gem install syslog -v '~> 0.3'
+gem install rmagick -v '~> 6.1'
+gem install debug -v '~> 1.11'
+gem install grpc-tools -v '~> 1.67'
+gem install rake -v '~> 13.0'
+gem install reek -v '~> 6.5.0'
+gem install rspec -v '~> 3.0'
+gem install rubocop -v '~> 1.75'
+gem install rubocop-ast -v '~> 1.4'
+gem install rubocop-performance -v '~> 1.10'
+gem install rubocop-shopify -v '~> 2.0'
+gem install simplecov -v '~> 0.22'
+gem install solargraph -v '~> 0.48'
 ```
 
 ### Ruby Gem: `aspera-cli`
@@ -626,7 +650,7 @@ gem install syslog -v '~> 0.3'
 Once you have Ruby and rights to install gems, install the `aspera-cli` gem and its dependencies:
 
 ```shell
-gem install aspera-cli --pre
+gem install aspera-cli
 ```
 
 To upgrade to the latest version:
@@ -782,11 +806,11 @@ Necessary gems can be packed in a `tar.gz` like this:
 
 ```bash
 mkdir temp_folder
-gem install aspera-cli:4.25.0.beta2 --no-document --install-dir temp_folder
+gem install aspera-cli:4.25.0 --no-document --install-dir temp_folder
 find temp_folder
-mv temp_folder/cache aspera-cli-4.25.0.beta2-gems
+mv temp_folder/cache aspera-cli-4.25.0-gems
 rm -fr temp_folder
-tar zcvf aspera-cli-4.25.0.beta2-gems aspera-cli-4.25.0.beta2-gems.tgz
+tar zcvf aspera-cli-4.25.0-gems aspera-cli-4.25.0-gems.tgz
 ```
 
 #### Unix-like
@@ -931,7 +955,7 @@ ascli -v
 ```
 
 ```text
-4.25.0.beta2
+4.25.0
 ```
 
 In order to keep persistency of configuration on the host, you should specify your user's configuration folder as a volume for the container.
@@ -2607,6 +2631,8 @@ preset delete conf_name
 preset initialize conf_name @json:'{"p1":"v1","p2":"v2"}'
 preset list
 preset overview
+preset set GLOBAL vault @: type=file file=/secure/vault_file
+preset set GLOBAL vault_password _simple_one_
 preset set GLOBAL version_check_days 0
 preset set conf_name param value
 preset set default shares conf_name
@@ -2624,7 +2650,8 @@ tokens flush
 tokens list
 transferd install
 transferd list
-vault create @json:'{"label":"my_label","password":"my_password_here","description":"my secret"}'
+vault create @: label=my_label password=my_password_here 'description=my secret'
+vault delete foo --vault.type=system
 vault delete my_label
 vault info
 vault list
@@ -2939,7 +2966,7 @@ ascli config vault create @json:'{"label":"mylabel","password":"my_password_here
 
 #### Configuration Finder
 
-When a secret is needed by a sub command, the command can search for existing configurations in the configuration file.
+When a secret is needed by a sub command, the command can search for existing configurations in the configuration file by setting option `secret` to the special value `PRESET`.
 
 The lookup is done by comparing the service URL and username (or access key).
 
@@ -4031,7 +4058,7 @@ ascli config ascp schema transferd --format=jsonpp
 | cookie | string | Metadata for transfer specified by application.<br/>(env:`ASPERA_SCP_COOKIE`) |
 | create_dir | boolean | Create target directory if it doesn't already exist.<br/>If **all** the following conditions are met, then the `destination_root` specifies a filename instead of destination folder:<br/>- `create_dir` is `false`<br/>- A single source file is given on **command line**<br/>- The target folder specified by `destination_root` does not exist<br/>In all other cases, `destination_root` specifies a folder, and it is created if it does not already exist. I.e. if **any** of those conditions is met:<br/>- `create_dir` is `true`<br/>- Multiple source files are provided<br/>- List of source files are provided in a file (list or pair), default for Node API and `ascli`.<br/>- The target folder exists<br/>(`-d`) |
 | delete_before_transfer | boolean | Before transfer, delete files that exist at the destination but not at the source.<br/>The source and destination arguments must be directories that have matching names.<br/>Objects on the destination that have the same name but different type or size as objects on the source are not deleted.<br/>(`--delete-before-transfer`) |
-| delete_source | boolean | Remove transfered source files after transfer success. Equivalent to `remove_after_transfer` + `remove_empty_directories` + `remove_empty_source_directory`. Take precedence over those.<br/>(A, N, T) |
+| delete_source | boolean | Remove transferred source files after transfer success. Equivalent to `remove_after_transfer` + `remove_empty_directories` + `remove_empty_source_directory`. Take precedence over those.<br/>(A, N, T) |
 | destination_root | string | Destination root directory. |
 | destination_root_id | string | The file ID of the destination root directory.<br/>Required when using Bearer token auth for the destination node.<br/>(T) |
 | dgram_size | integer | UDP datagram size in bytes.<br/>(`-Z {integer}`) |
@@ -4635,8 +4662,9 @@ ascli server upload "faux:///mydir?file=testfile&count=1000&size=1" --to-folder=
 
 ```text
 ascli -h
+WARN No config file found. New configuration file: /home/runner/.aspera/ascli/config.yaml
 NAME
-        ascli -- a command line tool for Aspera Applications (v4.25.0.beta2)
+        ascli -- a command line tool for Aspera Applications (v4.25.0)
 
 SYNOPSIS
         ascli COMMANDS [OPTIONS] [ARGS]
@@ -4681,7 +4709,7 @@ OPTIONS: global
         --bash-comp                  Generate bash completion for command
         --show-config                Display parameters used for the provided action
     -v, --version                    Display version
-        --ui=ENUM                    Method to start browser: text, [graphical]
+        --ui=ENUM                    Method to start browser: [text], graphical
         --invalid-characters=VALUE   Replacement character and invalid filename characters
         --log-level=ENUM             Log level: trace2, trace1, debug, info, [warn], error, fatal, unknown
         --log-format=VALUE           Log formatter (Proc, Logger::Formatter)
@@ -4730,15 +4758,38 @@ OPTIONS: global
         --to-folder=VALUE            Destination folder for transferred files
         --sources=VALUE              How list of transferred files is provided (@args,@ts,Array)
         --src-type=ENUM              Type of file list: [list], pair
-        --transfer=ENUM              Type of transfer agent: desktop, node, [direct], transferd, httpgw, connect
+        --transfer=ENUM              Type of transfer agent: httpgw, transferd, node, desktop, [direct], connect
         --transfer-info=VALUE        Parameters for transfer agent (Hash)
 
 COMMAND: config
 SUBCOMMANDS: ascp check_update coffee detect documentation download echo email_test file folder gem genkey image initdemo open platform plugins preset proxy_check pubkey remote_certificate smtp_settings sync test tokens transferd vault wizard
 
 
-COMMAND: shares
-SUBCOMMANDS: admin files health
+COMMAND: httpgw
+SUBCOMMANDS: health info
+OPTIONS:
+        --url=VALUE                  URL of application, e.g. https://app.example.com/aspera/app
+
+
+COMMAND: faspex5
+SUBCOMMANDS: admin bearer_token gateway health invitations packages postprocessing shared_folders user version
+OPTIONS:
+        --url=VALUE                  URL of application, e.g. https://app.example.com/aspera/app
+        --username=VALUE             User's identifier
+        --password=VALUE             User's password
+        --auth=ENUM                  OAuth type of authentication: web, [jwt], boot
+        --client-id=VALUE            OAuth client identifier
+        --client-secret=VALUE        OAuth client secret
+        --redirect-uri=VALUE         OAuth (Web) redirect URI for web authentication
+        --private-key=VALUE          OAuth (JWT) RSA private key PEM value (prefix file path with @file:)
+        --passphrase=VALUE           OAuth (JWT) RSA private key passphrase
+        --box=VALUE                  Package inbox, either shared inbox name or one of: inbox, inbox_history, inbox_all, inbox_all_history, outbox, outbox_history, pending, pending_history, all or ALL
+        --shared-folder=VALUE        Send package with files from shared folder
+        --group-type=ENUM            Type of shared box: [shared_inboxes], workgroups
+
+
+COMMAND: alee
+SUBCOMMANDS: entitlement health
 OPTIONS:
         --url=VALUE                  URL of application, e.g. https://app.example.com/aspera/app
         --username=VALUE             User's identifier
@@ -4759,36 +4810,33 @@ OPTIONS:
         --dynamic-key=VALUE          Private key PEM to use for dynamic key auth
 
 
-COMMAND: faspio
-SUBCOMMANDS: bridges health
+COMMAND: aoc
+SUBCOMMANDS: admin automation bearer_token files gateway organization packages reminder servers tier_restrictions user
 OPTIONS:
         --url=VALUE                  URL of application, e.g. https://app.example.com/aspera/app
         --username=VALUE             User's identifier
         --password=VALUE             User's password
-        --auth=ENUM                  OAuth type of authentication: jwt, basic
+        --auth=ENUM                  OAuth type of authentication: web, [jwt], boot
         --client-id=VALUE            OAuth client identifier
-        --private-key=VALUE          OAuth JWT RSA private key PEM value (prefix file path with @file:)
-        --passphrase=VALUE           OAuth JWT RSA private key passphrase
-
-
-COMMAND: orchestrator
-SUBCOMMANDS: health info monitors plugins processes workflows workorders workstep
-OPTIONS:
-        --url=VALUE                  URL of application, e.g. https://app.example.com/aspera/app
-        --username=VALUE             User's identifier
-        --password=VALUE             User's password
-        --result=VALUE               Specify result value as: 'work_step:parameter'
-        --synchronous=ENUM           Wait for completion: [no], yes
-        --ret-style=ENUM             How return type is requested in api: header, [arg], ext
-        --auth-style=ENUM            Authentication type: arg_pass, [head_basic], apikey
+        --client-secret=VALUE        OAuth client secret
+        --redirect-uri=VALUE         OAuth (Web) redirect URI for web authentication
+        --private-key=VALUE          OAuth (JWT) RSA private key PEM value (prefix file path with @file:)
+        --passphrase=VALUE           OAuth (JWT) RSA private key passphrase
+        --workspace=VALUE            Name of workspace
+        --new-user-option=VALUE      New user creation option for unknown package recipients (Hash)
+        --validate-metadata=ENUM     Validate shared inbox metadata: no, [yes]
+        --package-folder=VALUE       Handling of reception of packages in folders (Hash)
 
 
-COMMAND: alee
-SUBCOMMANDS: entitlement health
+COMMAND: server
+SUBCOMMANDS: browse cp delete df download du health info ls md5sum mkdir mv rename rm sync upload
 OPTIONS:
         --url=VALUE                  URL of application, e.g. https://app.example.com/aspera/app
         --username=VALUE             User's identifier
         --password=VALUE             User's password
+        --ssh-keys=VALUE             SSH key path list (Array)
+        --passphrase=VALUE           SSH private key passphrase
+        --ssh-options=VALUE          SSH options (Hash)
 
 
 COMMAND: ats
@@ -4802,56 +4850,6 @@ OPTIONS:
         --region=VALUE               Cloud region
 
 
-COMMAND: faspex5
-SUBCOMMANDS: admin bearer_token gateway health invitations packages postprocessing shared_folders user version
-OPTIONS:
-        --url=VALUE                  URL of application, e.g. https://app.example.com/aspera/app
-        --username=VALUE             User's identifier
-        --password=VALUE             User's password
-        --auth=ENUM                  OAuth type of authentication: web, [jwt], boot
-        --client-id=VALUE            OAuth client identifier
-        --client-secret=VALUE        OAuth client secret
-        --redirect-uri=VALUE         OAuth (Web) redirect URI for web authentication
-        --private-key=VALUE          OAuth (JWT) RSA private key PEM value (prefix file path with @file:)
-        --passphrase=VALUE           OAuth (JWT) RSA private key passphrase
-        --scope=VALUE                OAuth scope for API calls
-        --box=VALUE                  Package inbox, either shared inbox name or one of: inbox, inbox_history, inbox_all, inbox_all_history, outbox, outbox_history, pending, pending_history, all or ALL
-        --shared-folder=VALUE        Send package with files from shared folder
-        --group-type=ENUM            Type of shared box: [shared_inboxes], workgroups
-
-
-COMMAND: cos
-SUBCOMMANDS: node
-OPTIONS:
-        --bucket=VALUE               Bucket name
-        --endpoint=VALUE             Storage endpoint (URL)
-        --apikey=VALUE               Storage API key
-        --crn=VALUE                  Resource instance id (CRN)
-        --service-credentials=VALUE  IBM Cloud service credentials (Hash)
-        --region=VALUE               Storage region
-        --identity=VALUE             Authentication URL (https://iam.cloud.ibm.com/identity)
-
-
-COMMAND: httpgw
-SUBCOMMANDS: health info
-OPTIONS:
-        --url=VALUE                  URL of application, e.g. https://app.example.com/aspera/app
-
-
-COMMAND: faspex
-SUBCOMMANDS: address_book dropbox health login_methods me package source v4
-OPTIONS:
-        --url=VALUE                  URL of application, e.g. https://app.example.com/aspera/app
-        --username=VALUE             User's identifier
-        --password=VALUE             User's password
-        --link=VALUE                 Public link for specific operation
-        --delivery-info=VALUE        Package delivery information (Hash)
-        --remote-source=VALUE        Remote source for package send (id or %name:)
-        --storage=VALUE              Faspex local storage definition (for browsing source)
-        --recipient=VALUE            Use if recipient is a dropbox (with *)
-        --box=ENUM                   Package box: [inbox], archive, sent
-
-
 COMMAND: preview
 SUBCOMMANDS: check events scan show test trevents
 OPTIONS:
@@ -4887,42 +4885,70 @@ OPTIONS:
         --clips-length=VALUE         Mp4: clips: length in seconds of each clips
 
 
-COMMAND: aoc
-SUBCOMMANDS: admin automation bearer_token files gateway organization packages reminder servers tier_restrictions user
+COMMAND: orchestrator
+SUBCOMMANDS: health info monitors plugins processes workflows workorders workstep
 OPTIONS:
         --url=VALUE                  URL of application, e.g. https://app.example.com/aspera/app
         --username=VALUE             User's identifier
         --password=VALUE             User's password
-        --auth=ENUM                  OAuth type of authentication: web, [jwt], boot
-        --client-id=VALUE            OAuth client identifier
-        --client-secret=VALUE        OAuth client secret
-        --redirect-uri=VALUE         OAuth (Web) redirect URI for web authentication
-        --private-key=VALUE          OAuth (JWT) RSA private key PEM value (prefix file path with @file:)
-        --passphrase=VALUE           OAuth (JWT) RSA private key passphrase
-        --scope=VALUE                OAuth scope for API calls
-        --workspace=VALUE            Name of workspace
-        --new-user-option=VALUE      New user creation option for unknown package recipients (Hash)
-        --validate-metadata=ENUM     Validate shared inbox metadata: no, [yes]
-        --package-folder=VALUE       Handling of reception of packages in folders (Hash)
+        --result=VALUE               Specify result value as: 'work_step:parameter'
+        --synchronous=ENUM           Wait for completion: [no], yes
+        --ret-style=ENUM             How return type is requested in api: header, [arg], ext
+        --auth-style=ENUM            Authentication type: arg_pass, [head_basic], apikey
 
 
-COMMAND: server
-SUBCOMMANDS: browse cp delete df download du health info ls md5sum mkdir mv rename rm sync upload
+COMMAND: console
+SUBCOMMANDS: health transfer
 OPTIONS:
         --url=VALUE                  URL of application, e.g. https://app.example.com/aspera/app
         --username=VALUE             User's identifier
         --password=VALUE             User's password
-        --ssh-keys=VALUE             SSH key path list (Array)
-        --passphrase=VALUE           SSH private key passphrase
-        --ssh-options=VALUE          SSH options (Hash)
 
 
-COMMAND: console
-SUBCOMMANDS: health transfer
+COMMAND: shares
+SUBCOMMANDS: admin files health
+OPTIONS:
+        --url=VALUE                  URL of application, e.g. https://app.example.com/aspera/app
+        --username=VALUE             User's identifier
+        --password=VALUE             User's password
+
+
+COMMAND: cos
+SUBCOMMANDS: node
+OPTIONS:
+        --bucket=VALUE               Bucket name
+        --endpoint=VALUE             Storage endpoint (URL)
+        --apikey=VALUE               Storage API key
+        --crn=VALUE                  Resource instance id (CRN)
+        --service-credentials=VALUE  IBM Cloud service credentials (Hash)
+        --region=VALUE               Storage region
+        --identity=VALUE             Authentication URL (https://iam.cloud.ibm.com/identity)
+
+
+COMMAND: faspio
+SUBCOMMANDS: bridges health
 OPTIONS:
         --url=VALUE                  URL of application, e.g. https://app.example.com/aspera/app
         --username=VALUE             User's identifier
         --password=VALUE             User's password
+        --auth=ENUM                  OAuth type of authentication: jwt, basic
+        --client-id=VALUE            OAuth client identifier
+        --private-key=VALUE          OAuth JWT RSA private key PEM value (prefix file path with @file:)
+        --passphrase=VALUE           OAuth JWT RSA private key passphrase
+
+
+COMMAND: faspex
+SUBCOMMANDS: address_book dropbox health login_methods me package source v4
+OPTIONS:
+        --url=VALUE                  URL of application, e.g. https://app.example.com/aspera/app
+        --username=VALUE             User's identifier
+        --password=VALUE             User's password
+        --link=VALUE                 Public link for specific operation
+        --delivery-info=VALUE        Package delivery information (Hash)
+        --remote-source=VALUE        Remote source for package send (id or %name:)
+        --storage=VALUE              Faspex local storage definition (for browsing source)
+        --recipient=VALUE            Use if recipient is a dropbox (with *)
+        --box=ENUM                   Package box: [inbox], archive, sent
 
 
 ```
@@ -5302,7 +5328,7 @@ empty
 
 ### Calling AoC APIs from command line
 
-The command `ascli aoc bearer` can be used to generate an OAuth token suitable to call any AoC API (use the `scope` option to change the scope, default is `user:all`).
+The command `ascli aoc bearer` can be used to generate an OAuth token suitable to call any AoC API.
 This can be useful when a command is not yet available.
 
 Example:
@@ -6426,6 +6452,7 @@ admin ats cluster list
 admin ats cluster show --cloud=aws --region=eu-west-1
 admin ats cluster show 1f412ae7-869a-445c-9c05-02ad16813be2
 admin auth_providers list
+admin bearer_token --display=data
 admin client list
 admin client_access_key list
 admin client_registration_token create @json:'{"data":{"name":"test_client_reg1","client_subject_scopes":["alee","aejd"],"client_subject_enabled":true}}'
@@ -6437,7 +6464,7 @@ admin dropbox_membership list
 admin group list
 admin group_membership list --fields=ALL --query=@json:'{"page":1,"per_page":50,"embed":"member","inherited":false,"workspace_id":11363,"sort":"name"}'
 admin kms_profile list
-admin node bearer_token %name:my_node_name --scope=admin:all
+admin node bearer_token %name:my_node_name
 admin node do %name:my_node_name --secret=my_ak_secret browse /
 admin node do %name:my_node_name --secret=my_ak_secret browse /folder_sub --node-cache=no
 admin node do %name:my_node_name --secret=my_ak_secret delete /folder1
@@ -6474,9 +6501,9 @@ automation workflow action wf_id create @json:'{"name":"toto"}'
 automation workflow create @json:'{"name":"test_workflow"}'
 automation workflow delete wf_id
 automation workflow list
-automation workflow list --query=@json:'{"show_org_workflows":"true"}' --scope=admin:all
+automation workflow list --query=@json:'{"show_org_workflows":"true"}'
 automation workflow list --select=@json:'{"name":"test_workflow"}' --fields=id
-bearer_token --display=data --scope=user:all
+bearer_token --display=data
 files bearer /
 files bearer_token_node / --cache-tokens=no
 files browse /
@@ -6491,9 +6518,9 @@ files delete /testsrc
 files download --to-folder=. testdst/test_file.bin testdst/test_file.bin
 files download --transfer=connect testdst/test_file.bin
 files download --transfer=desktop testdst/test_file.bin
-files find /
-files find / '\.partial$'
-files find / @ruby:'->(f){f["type"].eql?("file")}'
+files find /sample_video
+files find /sample_video '\.partial$'
+files find /sample_video @ruby:'->(f){f["type"].eql?("file")}'
 files mkdir /testsrc
 files modify /some_folder @json:'{"mount_point":false}'
 files permission my_test_folder list
@@ -6513,15 +6540,15 @@ files upload --to-folder=/ test_file.bin --url=my_public_link_folder_no_pass
 files upload --to-folder=/testsrc test_file.bin
 files upload --to-folder=/testsrc test_file.bin test_file.bin
 files v3 info
-gateway @json:'{"url":"https://localhost:12345/aspera/faspex"}'
+gateway @json:'{"url":"https://localhost:12346/aspera/faspex"}'
 organization
 organization --format=image --fields=background_image_url --ui=text
 organization --url=my_public_link_recv_from_aoc_user
 packages browse package_id3 /
 packages list
 packages list --query=@json:'{"dropbox_name":"my_shared_inbox_name","sort":"-received_at","archived":false,"received":true,"has_content":true,"exclude_dropbox_packages":false}'
-packages receive ALL --once-only=yes --to-folder=. --lock-port=12345 --package-folder.fld.0=name --package-folder.fld.1=id --package-folder.opt=true
-packages receive ALL --once-only=yes --to-folder=. --lock-port=12345 --query=@json:'{"dropbox_name":"my_shared_inbox_name","archived":false,"received":true,"has_content":true,"exclude_dropbox_packages":false,"include_draft":false}' --ts=@json:'{"resume_policy":"sparse_csum","target_rate_kbps":50000}'
+packages receive ALL --once-only=yes --to-folder=. --lock-port=50101 --package-folder.fld.0=name --package-folder.fld.1=id --package-folder.opt=true
+packages receive ALL --once-only=yes --to-folder=. --lock-port=50101 --query=@json:'{"dropbox_name":"my_shared_inbox_name","archived":false,"received":true,"has_content":true,"exclude_dropbox_packages":false,"include_draft":false}' --ts=@json:'{"resume_policy":"sparse_csum","target_rate_kbps":50000}'
 packages receive INIT --once-only=yes --query=@json:'{"dropbox_name":"my_shared_inbox_name"}'
 packages receive package_id3 --to-folder=.
 packages receive package_id3 --to-folder=. /
@@ -6556,8 +6583,11 @@ ATS is usable either :
 
 ### IBM Cloud ATS : Creation of API key
 
+> [!NOTE]
+> If you are using ATS as part of AoC, then authentication is through AoC, not IBM Cloud.
+> Refer to the AoC section instead.
+
 This section is about using ATS with an IBM cloud subscription.
-If you are using ATS as part of AoC, then authentication is through AoC, not IBM Cloud.
 
 First get your IBM Cloud API key.
 For instance, it can be created using the IBM Cloud web interface, or using command line:
@@ -6750,7 +6780,7 @@ upload --sources=@ts --ts=@json:'{"paths":[{"source":"test_file.bin","destinatio
 upload --src-type=pair --sources=@json:'["test_file.bin","my_inside_folder/other_name_3"]' --transfer-info.quiet=false --progress=no
 upload --src-type=pair test_file.bin my_inside_folder/other_name_2 --notify-to=my_email_external '--transfer-info.ascp_args=@list: -l 100m'
 upload --src-type=pair test_file.bin my_upload_folder/other_name_5 --ts=@json:'{"cipher":"aes-192-gcm","content_protection":"encrypt","content_protection_password":"my_secret_here","cookie":"biscuit","create_dir":true,"delete_before_transfer":false,"delete_source":false,"exclude_newer_than":"-1","exclude_older_than":"-10000","fasp_port":33001,"http_fallback":false,"multi_session":0,"overwrite":"diff+older","precalculate_job_size":true,"preserve_access_time":true,"preserve_creation_time":true,"rate_policy":"fair","resume_policy":"sparse_csum"}'
-upload --to-folder=my_upload_folder/target_hot --lock-port=12345 --transfer-info=@json:'{"ascp_args":["--remove-after-transfer","--remove-empty-directories","--exclude-newer-than=-8","--src-base","hot_folder"]}' hot_folder
+upload --to-folder=my_upload_folder/target_hot --lock-port=50101 --transfer-info=@json:'{"ascp_args":["--remove-after-transfer","--remove-empty-directories","--exclude-newer-than=-8","--src-base","hot_folder"]}' hot_folder
 upload test_file.bin --to-folder=my_inside_folder --ts=@json:'{"multi_session":3,"multi_session_threshold":1,"resume_policy":"none","target_rate_kbps":100000}' --transfer-info=@json:'{"spawn_delay_sec":2.5,"multi_incr_udp":false}' --progress-bar=yes
 ```
 
@@ -7298,20 +7328,21 @@ ascli node -N --url=https://... --password="Bearer $(cat bearer.txt)" --root-id=
 --url=https://tst.example.com/path --password='Bearer node_bearer_token' --root-id=bearer_root_id access_key do self browse /
 access_key create @json:'{"id":"my_username","secret":"my_password_here","storage":{"type":"local","path":"/"}}'
 access_key delete my_username
-access_key do my_ak_name browse /
-access_key do my_ak_name delete /test_nd_ak2
-access_key do my_ak_name delete test_nd_ak3
-access_key do my_ak_name download test_nd_ak3 --to-folder=.
-access_key do my_ak_name find my_test_folder
-access_key do my_ak_name find my_test_folder @re:'\.jpg$'
+access_key do my_ak_name browse / --secret=my_ak_secret
+access_key do my_ak_name delete /test_nd_ak2 --secret=my_ak_secret
+access_key do my_ak_name delete test_nd_ak3 --secret=my_ak_secret
+access_key do my_ak_name download test_nd_ak3 --to-folder=. --secret=my_ak_secret
+access_key do my_ak_name find my_test_folder --secret=my_ak_secret
+access_key do my_ak_name find my_test_folder @re:'\.jpg$' --secret=my_ak_secret
 access_key do my_ak_name find my_test_folder @ruby:'->(f){f["name"].end_with?(".jpg")}'
-access_key do my_ak_name mkdir /tst_nd_ak
-access_key do my_ak_name mkfile /mkfile.txt 'hello world'
-access_key do my_ak_name mklink /mklink.txt --query=@json:'{"target":"/mkfile.txt","target_node_id":"123"}'
-access_key do my_ak_name node_info /
-access_key do my_ak_name rename /tst_nd_ak test_nd_ak2
-access_key do my_ak_name show %id:1
-access_key do my_ak_name upload 'faux:///test_nd_ak3?100k' --default-ports=no
+ --secret=my_ak_secret
+access_key do my_ak_name mkdir /tst_nd_ak --secret=my_ak_secret
+access_key do my_ak_name mkfile /mkfile.txt 'hello world' --secret=my_ak_secret
+access_key do my_ak_name mklink /mklink.txt --query=@json:'{"target":"/mkfile.txt","target_node_id":"123"}' --secret=my_ak_secret
+access_key do my_ak_name node_info / --secret=my_ak_secret
+access_key do my_ak_name rename /tst_nd_ak test_nd_ak2 --secret=my_ak_secret
+access_key do my_ak_name show %id:1 --secret=my_ak_secret
+access_key do my_ak_name upload 'faux:///test_nd_ak3?100k' --default-ports=no --secret=my_ak_secret
 access_key do self permission %id:bearer_root_id create @json:'{"access_type":"user","access_id":"666"}'
 access_key do self permission / delete 1
 access_key do self permission / show 1

data/lib/aspera/agent/factory.rb

@@ -16,15 +16,18 @@ module Aspera
         Aspera::Agent.const_get(agent.to_s.capitalize).new(**options)
       end
 
-      # Discover available agents
-      # @return [Array] list of symbols of agents
-      def list
+      IGNORED_ITEMS = %i[factory base]
+      # Available agents: :long : Capitalized name string, :short : single character symbol
+      ALL =
         Dir.children(File.dirname(File.expand_path(__FILE__)))
           .select{ |file| file.end_with?(Environment::RB_EXT)}
           .map{ |file| File.basename(file, Environment::RB_EXT).to_sym}
-          .reject{ |item| IGNORED_ITEMS.include?(item)}
-      end
-      IGNORED_ITEMS = %i[factory base]
+          .reject{ |item| IGNORED_ITEMS.include?(item)}.each_with_object({}) do |agent_sym, hash|
+          hash[agent_sym] = {
+            long:  agent_sym.to_s.capitalize,
+            short: agent_sym.eql?(:direct) ? :a : agent_sym.to_s[0].to_sym
+          }.freeze
+        end.freeze
       private_constant :IGNORED_ITEMS
     end
   end

data/lib/aspera/agent/transferd.rb

@@ -21,10 +21,10 @@ module Aspera
 
       private_constant :LOCAL_SOCKET_ADDR, :PORT_SEP, :AUTO_LOCAL_TCP_PORT
 
-      # @param url   [String] URL of the transfer manager daemon
-      # @param start [Bool]   if false, expect that an external daemon is already running
-      # @param stop  [Bool]   if false, do not shutdown daemon on exit
-      # @param base  [Hash]   base class options
+      # @param url   [String]  URL of the transfer manager daemon
+      # @param start [Boolean] If `false`, expect that an external daemon is already running
+      # @param stop  [Boolean] If `false`, do not shutdown daemon on exit
+      # @param base  [Hash]    Base class options
       def initialize(
         url:   AUTO_LOCAL_TCP_PORT,
         start: true,