aspera-cli 4.26.2 → 4.27.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3959459dc4ecd6fbc28e485b7665744293691d275d7597375b9ee2e80dfb9477
-  data.tar.gz: 62fe6561296d5a6f35473e7c7e831a3089e54fecdbd364a4042e01f993db180e
+  metadata.gz: 4cd55cd81317773b0a3db9df127c37d38c7d4eb4b3740c12d9e950a175cdb3b7
+  data.tar.gz: 8cf2aa9a26337d022f920ed616f61beaf45ee13a47e22f2908c374a1124a094c
 SHA512:
-  metadata.gz: 95a052413af5c03a31e74c5b71f359b4dcd7f2af34e59be7c5c2fb49af862b45ce76be92d464419da1c9c944e1d140cd5b957a72916f53384e95317faf08fbcf
-  data.tar.gz: ed1aaa7ac2079839f69b506044ca7129e16cc4eb2c371d3311deb598aa91c6ed22c15bac03f8398062768cbdfc8131dc4fcafe84b637ce2a8357fb8c3af5c515
+  metadata.gz: 66e364c4c859eb7b1495ba55095d0b737e87fb3c450fe3017f0848b8002ff686cdcd2f3ddc3054c20f524401489bfeda634a6c663e78ed217ae09e964bbc8e6e
+  data.tar.gz: c117f95520d0d36bfa37c8a0cbac78727f0b085b89a22d0fa7318a1918d6510fa37a7cf01754ff7f8e45b7b43696e8fa26fda743ec74a03b5a67220846de6ac6

data/CHANGELOG.md

@@ -1,5 +1,62 @@
 # Changes (Release notes)
 
+## 4.27.1
+
+Released: 2026-09-16
+
+### New Features
+
+* **global**: `browse` is now accepted as an alias for `ls` in `node access_key do`, `aoc files`, `aoc admin node do`, and `aoc admin ats access_key node`.
+* `config`: Vault: added support for 1Password as a secret store.
+* `config`: Preset secrets (passwords, keys) are now automatically moved to the vault when a preset is saved and a vault is used.
+* `httpgw`: Added asynchronous transfer mode — `last_job_id` is now exposed so a transfer can be submitted and its status queried later.
+* `direct`: Added asynchronous transfer mode — `last_job_id` is now exposed so a transfer can be submitted and its status queried later.
+* `preview`: `scan` now accepts an optional path or `%id:<file_id>` selector, allowing preview generation for one file or a subtree. Added the `--filter` option, supporting glob strings, regular expressions, and `@ruby:` Proc expressions.
+* `config`: Preset keys starting with `_` (e.g. `_comment`) are now ignored when a preset is applied as CLI options, allowing inline annotations in `config.yaml`.
+* **global**: New composite option `--out` groups all output rendering options with dot-notation sub-keys: `format`, `level`, `file`, `fields`, `select`, `table[.pivot]`, `flat`, `secrets`, `img`. Individual options preserved with deprecation warnings.
+* `config`: `preset set` now supports dot-notation keys with deep-merge and automatic type coercion.
+
+### Issues Fixed
+
+* `faspex5`: Wizard was incorrectly nesting `client_id` and `client_secret` under a `params:` sub-key in the generated preset, instead of placing them at the top level.
+* **global**: Assigning `@none:` to a `Hash`-typed option now correctly resets it to `nil` instead of being stored as a literal value.
+* `config`: Vault: removed `symmetric-encryption` gem dependency, replaced with `openssl`. Existing encrypted data may not be compatible — export your vault contents first, then re-import after upgrading.
+* `config`: Vault: fixed macOS Keychain API compatibility.
+* **global**: Option type `Hash` is now automatically inferred when the option schema uses `oneOf`/`anyOf` with all-object branches; no need to specify `allowed: Hash` explicitly.
+
+### Breaking Changes
+
+* `preview`: Options `--scan-id` and `--scan-path` are deprecated; use the optional `scan [path]` argument instead.
+* `faspex`: **Plugin removed** - Faspex v4 is end of support since September 30th, 2024. Use `ascli` version 4.19.0 or earlier if still needed.
+
+## 4.27.0
+
+Released: 2026-09-03
+
+> [!IMPORTANT]
+> This release includes a **major internal rework** of the command dispatch layer.
+> Plugin commands are now declared via a Ruby DSL (`command`, `commands_under`, `option`, `root_setup` on `Plugins::Base`), backed by `CommandRegistry` / `CommandSpec`, replacing the previous per-plugin `case`/`when` dispatch.
+> Help output is now generated directly, removing the dependency on `OptParse` and enabling proper multi-level help.
+> This change has been thoroughly tested, but if you encounter any unexpected behavior, please [open an issue](https://github.com/IBM/aspera-cli/issues) and consider reverting to the previous release.
+
+### New Features
+
+* `config`: `ascp install` / `transferd install`: Default version is now the SDK version tested with this release (`1.1.9`) instead of latest. Pass `LATEST` to install the latest available version.
+* `config`: New command commands `agents` with `list`, `show <name>` and `parameters <name>` to discover available transfer agents, their short identifier and their configurable parameters.
+* `mcp`: New plugin - starts a [Model Context Protocol](https://modelcontextprotocol.io/) server exposing `execute_ascli_command`. Supports `stdio` (default) and `http` (Streamable HTTP) transports.
+* **global**: Documentation for growing files using the `file` PVCL adapter (`file:///path?grow=<seconds>`).
+* **global**: New composite option `log` with sub-properties `level`, `type`, `format`.
+* **global**: Option `transfer` is now composite (`Hash`). `transfer` also accepts a `String` (`agent` shorthand) for backward compatibility.
+* `direct`: New `transfer` parameter `file_list` (default: `true`). Setting to `false` will pass source paths directly on the `ascp` command line instead of a temp file list.
+* **global**: New pseudo transfer-spec parameter `target_rate` (bps). It translates to `target_rate_kbps` with optional unit suffix (`k`/`K`, `m`/`M`, `g`/`G`). Example: `--ts.target_rate=100m`.
+* `config`: Bash completion (`config completion bash`) is now multi-level: pressing `Tab` after a plugin name or sub-command completes the next level of sub-commands (previously only first-level plugin names were completed).
+* **global**: Use `--query=help` on any `list` command to display the available filter parameters and their types, as documented in the embedded OpenAPI spec. Supported for `faspex5 admin` resources and `aoc admin` resources.
+
+### Breaking Changes
+
+* **global**: Option `--transfer-info` is deprecated in favor of `--transfer`.
+* **global**: Options `--log-level`, `--logger`, `--log-format` are deprecated in favor of option `--log`. Individual options preserved for backward compatibility.
+
 ## 4.26.2
 
 Released: 2026-07-17
@@ -949,19 +1006,34 @@ Released: 2021-02-03
 
 ## 0.11.8
 
+Released: 2020-11-30
+
+### New Features
+
 * Simplified to use `unoconv` instead of bare `libreoffice` for office conversion, as `unoconv` does not require an X server (previously using `Xvfb`).
 
 ## 0.11.7
 
-* Rework on rest call error handling.
+Released: 2020-11-27
+
+### New Features
+
 * Use option `display` with value `data` to remove out of extraneous information.
-* Fixed option `lock_port` not working.
 * Generate special icon if preview failed.
 * Possibility to choose transfer progress bar type with option `progress`.
 * AoC package creation now output package ID.
 
+### Issues Fixed
+
+* Rework on rest call error handling.
+* Fixed option `lock_port` not working.
+
 ## 0.11.6
 
+Released: 2020-11-19
+
+### New Features
+
 * `orchestrator`: Added more choice in auth type.
 * `preview`: Cleanup in generator (removed and renamed parameters).
 * `preview`: Better documentation.
@@ -972,164 +1044,311 @@ Released: 2021-02-03
 
 ## 0.11.5
 
+Released: 2020-11-16
+
+### New Features
+
 * Added option `default_ports` for AoC (see manual).
 * Allow bulk delete in `aspera files` with option `bulk=yes`.
-* Fix getting connect versions.
 * Added section for AIX.
 * Support all ciphers for [`direct`](README.md#agt_direct) agent (including GCM, etc.).
 * Added transfer spec parameter `apply_local_docroot` for [`direct`](README.md#agt_direct).
 
+### Issues Fixed
+
+* Fix getting connect versions.
+
 ## 0.11.4
 
+Released: 2020-10-16
+
+### New Features
+
 * Possibility to give shared inbox name when sending a package (else use ID and type).
 
 ## 0.11.3
 
+Released: 2020-10-12
+
+### Issues Fixed
+
 * Minor fixes on multi-session: Avoid exception on progress bar.
 
 ## 0.11.2
 
+Released: 2020-10-09
+
+### Issues Fixed
+
 * Fixes on multi-session: Progress bar and transfer spec parameter for `direct`.
 
 ## 0.11.1
 
+Released: 2020-10-01
+
+### New Features
+
 * Enhanced short_link creation commands (see examples).
 
 ## 0.11
 
+Released: 2020-09-23
+
+### New Features
+
 * Add transfer spec option (agent `direct` only) to provide file list directly to `ascp`: `EX_file_list`.
 
 ## 0.10.18
 
-* New option in. `server` : `ssh_options`.
+Released: 2020-09-15
+
+### New Features
+
+* New option in `server`: `ssh_options`.
 
 ## 0.10.17
 
-* Fixed problem on `server` for option `ssh_keys`, now accepts both single value and list.
+Released: 2020-09-01
+
+### New Features
+
 * New modifier: `@list:<separator>val1<separator>...`.
 
+### Issues Fixed
+
+* Fixed problem on `server` for option `ssh_keys`, now accepts both single value and list.
+
 ## 0.10.16
 
+Released: 2020-08-21
+
+### New Features
+
 * Added list of shared inboxes in workspace (or global), use `--query=@json:'{}'`.
 
 ## 0.10.15
 
-* In case of command line error, display the error cause first, and non-parsed argument second.
+Released: 2020-07-23
+
+### New Features
+
 * `aoc`: Activity / Analytics.
 
+### Issues Fixed
+
+* In case of command line error, display the error cause first, and non-parsed argument second.
+
 ## 0.10.14
 
+Released: 2020-06-17
+
+### New Features
+
 * Added missing `bss` plugin.
 
 ## 0.10.13
 
+Released: 2020-06-12
+
+### New Features
+
 * Added Faspex5 (use option `value` to give API arguments).
 
 ## 0.10.12
 
+Released: 2020-05-15
+
+### New Features
+
 * Added support for AoC node registration keys.
-* Replaced option : `local_resume` with `transfer_info` for agent [`direct`](README.md#agt_direct).
 * Transfer agent is no more a Singleton instance, but only one is used in CLI.
-* `@incps` : New extended value modifier.
-* ATS: No more provides access keys secrets: now user must provide it.
+* `@incps`: New extended value modifier.
 * Begin work on `aoc` transfer agent.
 
+### Breaking Changes
+
+* Replaced option `local_resume` with `transfer_info` for agent [`direct`](README.md#agt_direct).
+* `ats`: No more provides access keys secrets: now user must provide it.
+
 ## 0.10.11
 
+Released: 2020-04-29
+
+### Issues Fixed
+
 * Minor refactor and fixes.
 
 ## 0.10.10
 
+Released: 2020-04-10
+
+### Issues Fixed
+
 * Fix on documentation.
 
 ## 0.10.9.1
 
+Released: 2020-03-31
+
+### New Features
+
 * Add total number of items for AoC resource list.
+
+### Issues Fixed
+
 * Better gem version dependency (and fixes to support Ruby 2.0.0).
+
+### Breaking Changes
+
 * Removed `aoc search_nodes`.
 
 ## 0.10.8
 
-* Removed option: `fasp_proxy`, use pseudo transfer spec parameter: `EX_fasp_proxy_url`.
-* Removed option: `http_proxy`, use pseudo transfer spec parameter: `EX_http_proxy_url`.
-* Several other changes.
+Released: 2020-02-13
+
+### Breaking Changes
+
+* Removed option `fasp_proxy`, use pseudo transfer spec parameter: `EX_fasp_proxy_url`.
+* Removed option `http_proxy`, use pseudo transfer spec parameter: `EX_http_proxy_url`.
 
 ## 0.10.7
 
+Released: 2020-01-03
+
+### Issues Fixed
+
 * Fix: `ascli` fails when username cannot be computed on Linux.
 
 ## 0.10.6
 
+Released: 2019-12-11
+
+### New Features
+
 * FaspManager: Transfer spec `authentication` is no longer needed for local transfer to use Aspera public keys. Public keys will be used if there is a token and no key or password is provided.
 * Gem version requirements made more open.
 
 ## 0.10.5
 
+Released: 2019-12-11
+
+### Issues Fixed
+
 * Fix Faspex package receive command not working.
 
 ## 0.10.4
 
-* New options for AoC : `secrets`.
+Released: 2019-12-04
+
+### New Features
+
+* New options for AoC: `secrets`.
 * `ACLI-533` temp file list folder to use file lists is set by default, and used by `asession`.
 
 ## 0.10.3
 
+Released: 2019-12-02
+
+### New Features
+
 * Included username in OAuth bearer token cache for AoC when JWT is used.
 
 ## 0.10.2
 
+Released: 2019-11-25
+
+### New Features
+
 * Updated `search_nodes` to be more generic, so it can search not only on access key, but also other queries.
 * Added doc for "cargo" like actions.
 * Added doc for multi-session.
 
 ## 0.10.1
 
+Released: 2019-11-11
+
+### New Features
+
 * AoC and node v4 "browse" works now on non-folder items: file, link.
 * Initial support for AoC automation (do not use yet).
 
 ## 0.10
 
+Released: 2019-10-19
+
+### New Features
+
 * Support for transfer using IBM Cloud Object Storage.
 * Improved `find` action using arbitrary expressions.
 
 ## 0.9.36
 
+Released: 2019-10-16
+
+### New Features
+
 * Added option to specify file pair lists.
 
 ## 0.9.35
 
+Released: 2019-10-11
+
+### New Features
+
 * `preview`: Changed parameter names, added documentation.
+
+### Issues Fixed
+
 * `ats`: Fix: instance ID needed in request header.
 
 ## 0.9.34
 
+Released: 2019-10-03
+
+### Issues Fixed
+
 * Parser `@preset` can be used again in option `transfer_info`.
 * Some documentation re-organizing.
 
 ## 0.9.33
 
+Released: 2019-08-28
+
+### New Features
+
 * New command to display basic token of node.
 * New command to display bearer token of node in AoC.
 * The `--fields=` option, support `+_field_name_` to add a field to default fields.
-* Many small changes.
 
 ## 0.9.32
 
+Released: 2019-06-13
+
 ### New Features
 
 * All Faspex public links are now supported.
+
+### Breaking Changes
+
 * Removed Faspex operation `recv_publink`. Replaced with option `link` (consistent with AoC).
 
 ## 0.9.31
 
+Released: 2019-06-12
+
 ### New Features
 
 * Added more support for public link: receive and send package, to user or dropbox and files view.
-* Delete expired file lists.
 * Changed text table gem from text-table to terminal-table because it supports multiline values.
 
+### Issues Fixed
+
+* Delete expired file lists.
+
 ## 0.9.27
 
+Released: 2019-03-27
+
 ### New Features
 
 * Basic email support with SMTP.
@@ -1137,6 +1356,8 @@ Released: 2021-02-03
 
 ## 0.9.26
 
+Released: 2019-03-13
+
 ### New Features
 
 * Table display with `--fields=ALL` now includes all column names from all lines, not only first one.
@@ -1144,21 +1365,30 @@ Released: 2021-02-03
 
 ## 0.9.25
 
+Released: 2019-03-11
+
 ### New Features
 
-* The option `value` of command `find` to filter on name is mandatory.
 * `find` now also reports all types (file, folder, link).
 * `find` now is able to report all fields (type, size, etc...).
 
+### Breaking Changes
+
+* The option `value` of command `find` to filter on name is mandatory.
+
 ## 0.9.24
 
-### New Features
+Released: 2019-03-05
+
+### Issues Fixed
 
 * Fix bug where AoC node to node transfer did not work.
 * Fix bug on error if ED25519 private key is defined in .ssh.
 
 ## 0.9.23
 
+Released: 2019-03-04
+
 ### New Features
 
 * Defined REST error handlers, more error conditions detected.
@@ -1166,6 +1396,8 @@ Released: 2021-02-03
 
 ## 0.9.21
 
+Released: 2019-02-09
+
 ### New Features
 
 * Supports simplified wizard using global client.
@@ -1173,26 +1405,33 @@ Released: 2021-02-03
 
 ## 0.9.20
 
+Released: 2019-01-22
+
 ### New Features
 
 * Improved wizard (prepare for AoC global client ID).
-* Preview generator: Added option : `skip_format` with values `png`, `mp4`.
-* Removed outdated pictures from this doc.
+* Preview generator: Added option: `skip_format` with values `png`, `mp4`.
 
 ## 0.9.19
 
+Released: 2019-01-15
+
 ### New Features
 
 * Added command `aspera bearer --scope=xx`.
 
 ## 0.9.18
 
+Released: 2019-01-12
+
 ### New Features
 
 * Enhanced Aspera admin events to support query.
 
 ## 0.9.16
 
+Released: 2019-01-11
+
 ### New Features
 
 * AoC transfers are now reported in activity app.
@@ -1200,6 +1439,8 @@ Released: 2021-02-03
 
 ## 0.9.15
 
+Released: 2018-12-20
+
 ### New Features
 
 * New feature: `find` command in Aspera Files.
@@ -1207,21 +1448,36 @@ Released: 2021-02-03
 
 ## 0.9.12
 
+Released: 2018-12-13
+
 ### New Features
 
 * Add `nagios` commands.
-* Support of ATS for IBM Cloud, removed old version based on Aspera ID.
+* Support of ATS for IBM Cloud.
+
+### Breaking Changes
+
+* Removed old ATS implementation based on Aspera ID.
 
 ## 0.9.11
 
-* Support of ATS for IBM Cloud, removed old version based on Aspera ID.
+Released: 2018-11-29
+
+### New Features
+
+* Support of ATS for IBM Cloud.
 
 ### Breaking Changes
 
+* Removed old ATS implementation based on Aspera ID.
 * **global**: `@stdin` is now `@stdin:`.
 
 ## 0.9.10
 
+Released: 2018-11-20
+
+### New Features
+
 * Display SaaS storage usage with command: `aspera admin res node --id=nn info`.
 * Cleaner way of specifying source file list for transfers.
 
@@ -1232,6 +1488,8 @@ Released: 2021-02-03
 
 ## 0.9.9
 
+Released: 2018-11-14
+
 ### New Features
 
 * Now supports "cargo" for Aspera on Cloud (automatic package download).
@@ -1242,6 +1500,8 @@ Released: 2021-02-03
 
 ## 0.9.8
 
+Released: 2018-11-13
+
 ### New Features
 
 * `faspex`: Use option `once_only` set to `yes` to enable cargo like function. `id=NEW` deprecated.
@@ -1249,6 +1509,8 @@ Released: 2021-02-03
 
 ## 0.9.7
 
+Released: 2018-11-08
+
 ### New Features
 
 * Homogeneous transfer spec for `node` and [`direct`](README.md#agt_direct) transfer agents.
@@ -1259,6 +1521,8 @@ Released: 2021-02-03
 
 ## 0.9.6
 
+Released: 2018-10-30
+
 ### New Features
 
 * AoC: Added command to display current workspace information.
@@ -1269,13 +1533,20 @@ Released: 2021-02-03
 
 ## 0.9.5
 
+Released: 2018-10-22
+
 ### New Features
 
 * New parameter: `new_user_option` used to choose between public_link and invite of external users.
+
+### Issues Fixed
+
 * Fixed bug in wizard, and wizard uses now product detection.
 
 ## 0.9.4
 
+Released: 2018-10-19
+
 ### New Features
 
 * AoC Package send supports external users.
@@ -1287,6 +1558,8 @@ Released: 2021-02-03
 
 ## 0.9.3
 
+Released: 2018-10-18
+
 ### New Features
 
 * REST error message show host and code.
@@ -1301,18 +1574,24 @@ Released: 2021-02-03
 
 ## 0.9.2
 
+Released: 2018-10-11
+
 ### Breaking Changes
 
 * `aoc`: Changed AoC package creation to match API, see AoC section.
 
 ## 0.9.1
 
+Released: 2018-10-08
+
 ### Breaking Changes
 
 * `faspex`: Changed Faspex package creation to match API, see Faspex section.
 
 ## 0.9
 
+Released: 2018-10-04
+
 ### New Features
 
 * Automatic rename and conversion of former config folder from `aslmcli` to `ascli`.
@@ -1323,12 +1602,16 @@ Released: 2021-02-03
 
 ## 0.7.6
 
+Released: 2018-08-30
+
 ### New Features
 
 * Add `sync` plugin.
 
 ## 0.7
 
+Released: 2018-05-31
+
 ### New Features
 
 * AoC: Receive package from public link.
@@ -1342,6 +1625,8 @@ Released: 2021-02-03
 
 ## 0.6.19
 
+Released: 2018-04-27
+
 ### Breaking Changes
 
 * `ats`: `ats server list provisioned` &rarr; `ats cluster list`.
@@ -1355,12 +1640,16 @@ Released: 2021-02-03
 
 ## 0.6.18
 
+Released: 2018-04-19
+
 ### New Features
 
 * Some commands take now `--id` option instead of `id` command.
 
 ## 0.6.15
 
+Released: 2018-04-16
+
 ### Breaking Changes
 
 * `aspera`: `files` application renamed to `aspera` (for "Aspera on Cloud"). `repository` renamed to `files`. Default is automatically reset, e.g. in config files and change key `files` to `aspera` in preset `default`.