aspera-cli 4.29.0 → 4.29.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (78) hide show
  1. checksums.yaml +4 -4
  2. checksums.yaml.gz.sig +2 -1
  3. data/CHANGELOG.md +76 -2
  4. data/README.md +20 -1
  5. data/SECURITY.md +14 -0
  6. data/docs/README.md +277 -38
  7. data/lib/aspera/api/node.rb +9 -2
  8. data/lib/aspera/ascp/installation.rb +26 -4
  9. data/lib/aspera/ascp/log_analyzer/lines.rb +2 -2
  10. data/lib/aspera/ascp/log_analyzer.rb +19 -3
  11. data/lib/aspera/ascp/log_locations.rb +163 -0
  12. data/lib/aspera/cli/ascp_logs_actions.rb +12 -0
  13. data/lib/aspera/cli/bootstrapper.rb +1 -0
  14. data/lib/aspera/cli/command_line.rb +39 -2
  15. data/lib/aspera/cli/command_registry.rb +3 -0
  16. data/lib/aspera/cli/command_spec.rb +13 -0
  17. data/lib/aspera/cli/error.rb +3 -0
  18. data/lib/aspera/cli/extended_value.rb +5 -4
  19. data/lib/aspera/cli/formatter.rb +14 -8
  20. data/lib/aspera/cli/http.rb +26 -1
  21. data/lib/aspera/cli/info.rb +1 -1
  22. data/lib/aspera/cli/mcp/tool.rb +5 -3
  23. data/lib/aspera/cli/option_value.rb +14 -8
  24. data/lib/aspera/cli/options.schema.yaml +156 -19
  25. data/lib/aspera/cli/parser.rb +15 -3
  26. data/lib/aspera/cli/plugins/aoc.rb +4 -2
  27. data/lib/aspera/cli/plugins/ats.rb +1 -1
  28. data/lib/aspera/cli/plugins/base.rb +33 -6
  29. data/lib/aspera/cli/plugins/config.rb +12 -1
  30. data/lib/aspera/cli/plugins/faspex5.rb +3 -1
  31. data/lib/aspera/cli/plugins/mcp.rb +14 -0
  32. data/lib/aspera/cli/plugins/node.rb +8 -8
  33. data/lib/aspera/cli/plugins/oauth.rb +18 -5
  34. data/lib/aspera/cli/plugins/orchestrator.rb +28 -24
  35. data/lib/aspera/cli/plugins/preview.rb +3 -1
  36. data/lib/aspera/cli/plugins/server.rb +3 -3
  37. data/lib/aspera/cli/plugins/shares.rb +1 -2
  38. data/lib/aspera/cli/plugins/transferd.rb +7 -2
  39. data/lib/aspera/cli/poll.rb +236 -0
  40. data/lib/aspera/cli/preset_manager.rb +63 -19
  41. data/lib/aspera/cli/prompt.rb +153 -8
  42. data/lib/aspera/cli/runner.rb +25 -7
  43. data/lib/aspera/cli/security.rb +10 -0
  44. data/lib/aspera/cli/sync_actions.rb +2 -0
  45. data/lib/aspera/cli/transfer_agent.rb +14 -0
  46. data/lib/aspera/cli/transfer_progress.rb +6 -5
  47. data/lib/aspera/cli/version.rb +1 -1
  48. data/lib/aspera/environment.rb +3 -1
  49. data/lib/aspera/id_generator.rb +16 -3
  50. data/lib/aspera/inflate.rb +43 -0
  51. data/lib/aspera/oauth/client/base.rb +38 -8
  52. data/lib/aspera/oauth/client/factory.rb +35 -15
  53. data/lib/aspera/oauth/client/json_credentials.rb +3 -2
  54. data/lib/aspera/oauth/client/shares_web.rb +13 -4
  55. data/lib/aspera/oauth/client/url_json.rb +3 -2
  56. data/lib/aspera/oauth/client/web.rb +2 -2
  57. data/lib/aspera/orchestrator_workflow_checker.rb +10 -1
  58. data/lib/aspera/preview/terminal.rb +8 -2
  59. data/lib/aspera/products/desktop.rb +13 -1
  60. data/lib/aspera/rest/client.rb +23 -5
  61. data/lib/aspera/schema/registry.rb +1 -0
  62. data/lib/aspera/sealed_hash.rb +2 -18
  63. data/lib/aspera/secret/hider.rb +13 -1
  64. data/lib/aspera/secret/store/one_password_cli.rb +13 -11
  65. data/lib/aspera/sync/operations.rb +4 -4
  66. data/lib/aspera/transfer/result.rb +20 -0
  67. data/lib/aspera/transfer/spec.rb +2 -2
  68. data/lib/aspera/{transfer/units.rb → units/decimal.rb} +4 -12
  69. data/lib/aspera/units/duration.rb +109 -0
  70. data/lib/aspera/uri_reader.rb +11 -6
  71. data/lib/aspera/web_auth/reply.html.erb +1 -1
  72. data/llms-install.md +88 -0
  73. data/llms.txt +6 -0
  74. data/skills/ascli/SKILL.md +6 -0
  75. data.tar.gz.sig +0 -0
  76. metadata +7 -3
  77. metadata.gz.sig +0 -0
  78. data/lib/aspera/duration.rb +0 -45
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 22b08acc7dfd929269009bc08f4419d5097e3d170d5095777a099efa9778ba58
4
- data.tar.gz: c517da2115165b0ee092783ff62753a3f96cbb853758ba9ef5bc56b008dc2983
3
+ metadata.gz: 46d9510afc080707a271eb0406f1b4b15189b6ac7f859defb24d91f775c5f49d
4
+ data.tar.gz: efdd014269e0e732a3c6bdd24fe92a46b82cc773ee979e6831afdbd7e1f4a6eb
5
5
  SHA512:
6
- metadata.gz: 3eedce17b67bdfa8b838e3d283da26cc30c3d149542aa4e20ca4160698f8412fbf9751a0e20393d77c1a03748a506eaaba2418875057a0ddebe2797de5339b33
7
- data.tar.gz: b02389f18f68d814fe55a2b2eb98b39d536c894bc8e9e4ede77f72d05861e01077b5f29e29aa43b81767ae4ea7817b9c6bd4463987bd5d5e54d2e64aa43dd625
6
+ metadata.gz: 9229948b74dfa1580e080ab4e0a922c1581f937c6c625c01befe3553dc36cc8cb532f0284446eb33d68e229a0ea9b50e51409da731ef9f58eb6badf5859c2982
7
+ data.tar.gz: 73d3a019a14fe1d47ab0292a4fd89871725cef5a96205b0c935e530da5c54d545919ff943b36850fb581e07ba393b8fba4b3d472ba6c681e2fdb3192c58e35fd
checksums.yaml.gz.sig CHANGED
@@ -1 +1,2 @@
1
- �,u<}0�u�!��<<�HٕͩW��d��F�kz��_w!�;�������4�U�T���,^
1
+ v-qhV'��p�f�],QL�e�D>i ��ƂحQ
2
+ G����k��lۄ%����`#�q��G e5E�`�S���L��Jƨ�Ҙ�%�h�Lzop.��ָ��+�@T��64�w��p���O(�&rkT�+0<ztF]R��<�-P=X�k���L�j����Y*[����tG۪����v�jY�#� ������x�T� 0����B��ljTK".M(��x�1��)Nw�Z�T\�Qǭ��>�J��0
data/CHANGELOG.md CHANGED
@@ -1,5 +1,79 @@
1
1
  # Changes (Release notes)
2
2
 
3
+ ## 4.29.1
4
+
5
+ Released: 2026-11-20
6
+
7
+ ### New Features
8
+
9
+ * New option `poll`: repeats a read-only command and displays its result (each time it changes, each time, or the last one), until a JMESPath condition on the result is true, or a number of runs or a time is reached, e.g. ``orchestrator workorders status <ID> --poll=@json:'{"interval":10,"max":30,"until":"status == `Complete`"}'``. Parameters `interval`, `max`, `timeout`, `until`, `show`, `errors` (`fail` or `retry`). Refused on a command that is not marked read-only (e.g. `faspex5 packages send`), with options `once_only` and `notify_to`, and in MCP server mode. Read-only: commands named `list`, `show`, `status`, `info`, `health`, `ls`, `browse` and `find` (except `preview show`: it generates a preview file), and others, e.g. `orchestrator workflows workorders`, `server du`, `node ssync state`.
10
+ * `config`: new command `skill`: displays the agent skill (same content as `llms.txt`), for an AI that does not install skills, in a shell or through `mcp server`.
11
+ * `mcp server`: the default instructions tell the AI to read the Aspera on Cloud Automation Development Guide before writing a workflow (sections to start with, for example `package-transfer` for action "Send a package"), and point to `config skill` for general guidance. The agent skill and `llms.txt` give the same starting sections.
12
+ * Chocolatey package `aspera-cli`: installs the Windows portable package (Ruby, gems and `ascp` included, checked with its SHA-256) instead of Ruby and the gem, and adds only `ascli` to the `PATH`. It is built, tested and published by the release workflow.
13
+ * Hidden input (passwords, code or URL pasted after a web login): a mark shows the state, without revealing the length: `🔑` while the input is empty, `…` once something is typed or pasted (`***` and `...` without Unicode). Ctrl-U erases the input, e.g. to paste again. `--ui.hidden_silent=yes` reads without mark (no feedback, as before). A terminal without raw mode (error `Inappropriate ioctl for device`) reads the line as is. An input that is checked while typed or pasted (the code displayed by Shares for `--auth=web` with `--ui.web_auth=paste`) shows `✓` (green) if valid, else `✗` (red) (`valid` and `invalid` without Unicode), and is asked again if `Enter` is pressed while it is not valid.
14
+ * Web login without local port (`--ui.web_auth=paste`): the page that shows the code after `config web_login` tells how long it is valid (15 minutes). Same for the page of the Shares patch for `--auth=web` (`docs/shares`), which also tells how long the session token is valid (24 hours, from the constant of Shares).
15
+
16
+ * OAuth: new key `token_refresh_max_age` of option `http_options`: a cached token obtained since more than this duration (seconds) is refreshed before use (default: `0`, no limit). With an `ascli` command run more often than the lifetime of the refresh token (e.g. every 12 hours), it keeps a session alive without new login, e.g. with Shares whose token and refresh token both expire after 24 hours: `--http-options=@json:'{"token_cache_max_age":"1d","token_refresh_max_age":"12h"}'`.
17
+ * `http_options`: durations (timeouts, `retry_sleep`, `token_*`, `jwt_*`) accept a string, e.g. `30s`, `12h`, `1d`, `1h 30m`, in addition to a number of seconds. Keys `jwt_accepted_offset_sec` and `jwt_expiry_offset_sec` are documented.
18
+ * Plugins: the manual has a section "Writing a plugin" for a plugin loaded with option `plugin_folder`: file and class names, files of the gem to require, options, commands, actions, results, REST client, with an example.
19
+ * Plugins: an unexpected error in a plugin (e.g. `Other(NoMethodError)`) also logs its location in the plugin (file and line) at level `info`.
20
+ * Plugins: modules `OauthWebOptions` (`client_id`, `client_secret`, `redirect_uri`) and `OauthJwtOptions` (`private_key`, `passphrase`) give the options of `Oauth`: a plugin of the OAuth web flow only adds them with `use_options OauthWebOptions`. Options of the existing plugins do not change.
21
+ * OAuth: parameter `token_field` accepts a dot-separated path of a nested field of the token answer, e.g. `authed_user.access_token` (user token of Slack OAuth v2). A plain field name is read as before.
22
+ * OAuth: parameters `path_authorize` and `path_token` accept an absolute URL (`http` or `https`), used as is, e.g. a token created on another host than the authorization page. The token cache still depends on `base_url` only: no new login for existing configurations.
23
+ * `transferd install`, `transferd list`: the request for the list of SDK archives (option `locations_url`) includes the version of `ascli` in the HTTP header `Referer`.
24
+ * `transferd install`: the list of SDK archives is no longer read when the requested version is already installed, and is read once per installation instead of twice.
25
+ * REST: a raw body is sent as is when no `content_type` is given: a `String` (e.g. binary data), or an `IO` (e.g. a file) streamed from its current position, without loading it in memory, and sent again from the same position on retry. Its type is in `headers` (`Content-Type`). It was ignored, so a binary body needed `content_type: Mime::TEXT` and a `Content-Type` header.
26
+
27
+ ### Issues Fixed
28
+
29
+ * Linux single executable, Linux and Windows portable packages, container image: Ruby 4.0.10 instead of 4.0.9, which has vulnerabilities in `Regexp` and `String` ([Ruby security release of 2026-11-18](https://www.ruby-lang.org/en/news/2026/11/18/multiple-vulnerabilities-in-regexp-and-string/)). With the gem, `ascli` runs on the Ruby of the system: update it to 4.0.10, 3.4.13 or 3.3.14.
30
+ * Option `security`, `mcp server`: extended value `@zlib:` was accepted at levels `medium` and `high`: a client could send a small value that decompresses to gigabytes (e.g. `@zlib:@zlib:<DATA>`), and exhaust the memory of the system. It is now refused at these levels, as `@ruby:`, `@uri:` and `@env:`. It is not limited at level `low`. Reported by visionx7.
31
+ * `orchestrator workflows import` and `check_import`: a workflow package (`.wkf`) was decompressed in memory without limit for the local check, so a small package could exhaust the memory (e.g. 1 MB for 1 GiB). A package whose files exceed 256 MiB once decompressed is now reported (issue `package.too_large`) and not decompressed: the size is read in the archive before each file.
32
+ * Node API bearer token (e.g. option `password` of plugin `node`, or a token in cache): it was decompressed without limit, so a small token could exhaust the memory. The decoded token is now limited to 64 KiB, checked while decompressing.
33
+ * Option `security`, `mcp server`: `orchestrator workflows check_import` read any local file at levels `medium` and `high`, and its issues show parts of the content. It now reads the file as `@file:`: only in `allowed_paths` at level `medium`, refused at level `high`. `workflows import` sends the file, as a transfer: not restricted.
34
+ * `config ascp info`: key `log` was always `-` (`ascp` is run with `-L-` to read its paths). It is now where `ascp` logs without option `-L`: `<logging><directory>` of `aspera.conf`, else `~/Library/Logs/Aspera` on macOS, `var\log` of the product (or the folder of `ascp`) on Windows, `syslog` on Linux and Unix.
35
+ * Logs (`--log-level=trace1`, `trace2`): the value of a secret option given on command line (e.g. `--password=<PASSWORD>`, `--vault.password=<PASSWORD>`) was shown in clear in the logs of the command line, of unprocessed options, and of the evaluation of the option. It is now declared as a secret when the command line is read, by option name, as is a structured value with a secret key (e.g. `--vault=@json:'{"password":"<PASSWORD>"}'`), and a short value (less than 8 characters) is hidden too in these logs.
36
+ * Option `dry_run` was ignored by all commands except `transferd service`, e.g. `server download` transferred files. A transfer command now does not transfer, and its result is the final transfer spec (secrets hidden). Commands that change something before the transfer (`aoc packages send`, `faspex5 packages send`: the package is created first), `sync` commands and `preview` generation are refused with option `dry_run`, before any change.
37
+ * Option `show_config`: after the configuration, the error `unprocessed values` was displayed (exit code 2) when the command had arguments, e.g. `server browse / --show-config`. Arguments of the command, not executed, are not reported anymore, unknown options still are.
38
+ * Logs (`--log-level=debug`): the value of a secret option given in an environment variable (e.g. `ASCLI_PASSWORD`, `ASCLI_VAULT_PASSWORD`) was shown in clear in the dump of environment values, and that of a secret option given on command line to `config preset update` (e.g. `--password=<PASSWORD>`) in the log of the option. Values of options from environment, presets and command line that are not declared yet are now hidden, by option name, as those of declared options.
39
+ * OAuth: an opaque token (not a JWT, e.g. Shares) was used until rejected by the server: its refresh token, if it expires at the same time, could no longer be used. The expiration given at creation (`expires_in`) is now kept in cache (`expires_at`), and the token is refreshed before it expires (`token_refresh_threshold`).
40
+ * `orchestrator workflows find_constraints`: the optional workflow ID was required ("Missing argument: add_as_revision"): an optional argument of type identifier was always mandatory. `orchestrator workflows import_with_constraints`: `add_as_revision` accepts `null` (new workflow).
41
+ * Extended value `@extend:` followed by a single extended value, e.g. `@json:@extend:@file:<PATH>`: the text on the right was taken as is (`unexpected character: '@file:...'`) instead of being decoded first, as other decoders. It is now decoded, then its embedded values (e.g. `"@vault:<LABEL>.<FIELD>@"` in a JSON file) are evaluated. With a closing `@` (`@extend:@file:<PATH>@`) the content is still inserted as is, not evaluated again.
42
+ * `mcp server`: when the optional gem `mcp` is not installed, the error was `uninitialized constant Cli` instead of the message telling to install it.
43
+ * Vault 1Password (`op`): creating a secret (e.g. `config vault create`, `config preset secure`) failed with `invalid JSON in piped input`, because `op item create` reads an item template on its standard input when it is not a terminal. The fields are now given to `op` in a JSON template on its standard input, so the secret is no longer on its command line.
44
+ * Wizard: an existing default preset for the plugin was replaced without error when `override=yes` was not given: the check (`A default configuration already exists`) never applied.
45
+ * Display of an image as text in a terminal that does not report its size (0 x 0, e.g. a pseudo-terminal) or without console: the image was scaled to nothing or failed (`Cannot decode picture.`). The default size 24 x 80 is now used.
46
+ * Display of an image as text without the optional gem `rmagick`: an image that ChunkyPNG does not decode (e.g. JPEG) failed with `cannot load such file -- rmagick`, instead of being displayed with the iTerm2 inline image protocol (if supported by the terminal) or failing with `Cannot decode picture.`.
47
+
48
+ ### Breaking Changes
49
+
50
+ ### Server Versions
51
+
52
+ Tested with Ruby 4.0.9 on osx-arm64.
53
+
54
+ | Plugin | Product | Version |
55
+ | ------------ | ------------------------------------------------ | ---------------- |
56
+ | `aoc` | IBM Aspera on Cloud | SaaS |
57
+ | `console` | IBM Aspera Console | 3.4.11 |
58
+ | `faspex5` | IBM Aspera Faspex | 5.0.19 |
59
+ | `faspio` | IBM Aspera faspio Gateway | 1.3.7 |
60
+ | `httpgw` | IBM Aspera HTTP Gateway | 2.3.4 |
61
+ | `node` | IBM Aspera High-Speed Transfer Server (Node API) | 4.4.9.3472 |
62
+ | `orchestrator` | IBM Aspera Orchestrator | 4.1.6.2036-00000 |
63
+ | `server` | IBM Aspera High-Speed Transfer Server (SSH) | 4.4.9.3472 |
64
+ | `shares` | IBM Aspera Shares | 1.11.5 |
65
+
66
+ ### Transfer Agent Versions
67
+
68
+ | Agent | Product | Version |
69
+ | --------- | ------------------------------------------------ | ---------- |
70
+ | `connect` | IBM Aspera Connect | 4.2.16 |
71
+ | `desktop` | IBM Aspera for Desktop | 1.1.2 |
72
+ | `direct` | IBM Aspera ascp | 4.4.8.2592 |
73
+ | `httpgw` | IBM Aspera HTTP Gateway | 2.3.4 |
74
+ | `node` | IBM Aspera High-Speed Transfer Server (Node API) | 4.4.9.3472 |
75
+ | `transferd` | IBM Aspera Transfer Daemon | 1.1.9 |
76
+
3
77
  ## 4.29.0
4
78
 
5
79
  Released: 2026-11-17
@@ -18,12 +92,12 @@ Highlights:
18
92
  ### New Features
19
93
 
20
94
  * `ascli`:
21
- * New file `llms.txt` (in the gem and in the repository): what `ascli` does with IBM Aspera products, and how to discover commands, arguments and options, on the command line or through `mcp server`. Same content as an agent skill in folder `skills/ascli`. The repository is also a Claude Code plugin marketplace: `/plugin install ascli --marketplace IBM/aspera-cli`.
95
+ * New file `llms.txt` (in the gem and in the repository): what `ascli` does with IBM Aspera products, and how to discover commands, arguments and options, on the command line or through `mcp server`. Same content as an agent skill in folder `skills/ascli`. The repository is also a Claude Code plugin marketplace: `/plugin marketplace add IBM/aspera-cli`, then `/plugin install ascli@aspera-cli`.
22
96
  * Web authentication (`--auth=web`): new key `web_auth` of option `ui`. With `--ui.web_auth=paste`, no local port is opened: after login, the user pastes in the terminal the URL the browser was redirected to. It allows SSO when the browser cannot reach the host that runs `ascli` (e.g. jump server). If `ascli` is also installed on the workstation, it displays a command `ascli config web_login <code>` to run there instead. Default: `port` (unchanged).
23
97
  * Improved shell completion: structures, extended values, local files and folders, presets (with their `_comment`), transfer jobs and `--query`.
24
98
  * SSH keys of type `ed25519` are supported without additional gem. Gem `bcrypt_pbkdf` is only needed for OpenSSH keys protected by a passphrase.
25
99
  * `config`:
26
- * New command `ascp logs`: analysis of `ascp` log files (`ascp` 4.0 and later), of client and server (joined by session). Sub-commands: statistics, `sessions` (with context columns: product, transport, authentication, proxy, FIPS), `diagnostics` (severity, category, hint and recommended `ascp` options or `aspera.conf` parameters), `health` (Nagios format), multi-session transfers, rates per period, errors by peer, files, licenses, and parsed `records` for `--out.query`. Accepts gzip files, folders and the standard input (`-`). New option `ascp_logs`: thresholds of diagnostics, `timezone`, `health_minutes`.
100
+ * New command `ascp logs`: analysis of `ascp` log files (`ascp` 4.0 and later), of client and server (joined by session). Sub-commands: statistics, `sessions` (with context columns: product, transport, authentication, proxy, FIPS), `diagnostics` (severity, category, hint and recommended `ascp` options or `aspera.conf` parameters), `health` (Nagios format), multi-session transfers, rates per period, errors by peer, files, licenses, and parsed `records` for `--out.query`. Accepts gzip files, folders and the standard input (`-`). Command `find` lists the `ascp` log files of the local system: log folders of installed products and of `ascp` in `PATH` (and `<logging><directory>` of their `aspera.conf`), of IBM Aspera for Desktop, of the transferd service, and default locations of `ascp` for the OS (syslog files on Linux). New option `ascp_logs`: thresholds of diagnostics, `timezone`, `health_minutes`.
27
101
  * `ascp errors`: optional argument `session` lists error codes found in logs, with category and the corresponding error of the management port.
28
102
  * `vault`: option `vault` declares several named stores: `{"default":"<name>","cache_ttl":60,"stores":{"<name>":{"type":...}}}`. A secret can be read from any store with `@vault://<store>/<path>[?<options>][#<field>]`; `@vault:<label>.<field>` uses the default store. New commands `vault stores`, `check`, `overview` and `field <label>`: they inspect stores and secrets without showing values. The former single-store form of option `vault` is deprecated, and converted when the configuration file is loaded (a backup is saved). `@file:` in options `vault` and `vault_password` is restricted by option `security` (refused by default in `mcp server`).
29
103
  * `vault` type `file`: parameter `password` (value, or `@file:<path>`) replaces option `vault_password`.
data/README.md CHANGED
@@ -55,6 +55,8 @@ ascli server browse /
55
55
  ascli server download /aspera-test-dir-small/10MB.1
56
56
  ```
57
57
 
58
+ Watch it first: [IBM Aspera in 60 seconds](https://youtu.be/TBf1W1mmX0A) (video, 1 min 23 s), more demos on the [Aspera CLI YouTube channel](https://www.youtube.com/@AsperaCLI).
59
+
58
60
  ## Examples
59
61
 
60
62
  ```bash
@@ -81,9 +83,26 @@ Each product has its own plugin (`aoc`, `faspex5`, `shares`, `node`, `server`, `
81
83
 
82
84
  `ascli` lets AI assistants and AI agents (LLM) operate IBM Aspera products for you, with the same commands, presets and secrets as you:
83
85
 
84
- - **In a shell** (coding agents): nothing to set up. Give the agent [`llms.txt`](https://github.com/IBM/aspera-cli/blob/main/llms.txt), or install the agent skill [`skills/ascli`](https://github.com/IBM/aspera-cli/tree/main/skills/ascli) (with Claude Code: `/plugin install ascli --marketplace IBM/aspera-cli`): the agent then discovers commands, arguments and options by itself.
86
+ - **In a shell** (coding agents): nothing to set up. Give the agent [`llms.txt`](https://github.com/IBM/aspera-cli/blob/main/llms.txt), or install the agent skill [`skills/ascli`](https://github.com/IBM/aspera-cli/tree/main/skills/ascli) (with Claude Code: `/plugin marketplace add IBM/aspera-cli`, then `/plugin install ascli@aspera-cli`): the agent then discovers commands, arguments and options by itself.
85
87
  - **MCP server** (Model Context Protocol): `ascli mcp server` exposes all commands to any MCP client (IBM Bob, Claude, VS Code...), locally or over HTTPS with token or OAuth authentication.
86
88
 
89
+ MCP server setup: install the optional gem `mcp` with `ascli` (and `rack` for HTTPS), then declare the server in the MCP client (local, `stdio`):
90
+
91
+ ```bash
92
+ gem install aspera-cli mcp
93
+ ```
94
+
95
+ ```json
96
+ {
97
+ "mcpServers": {
98
+ "ascli": {
99
+ "command": "ascli",
100
+ "args": ["mcp", "server"]
101
+ }
102
+ }
103
+ }
104
+ ```
105
+
87
106
  Safe by default: in the MCP server, the AI can neither execute code nor write files where it chooses, and never sees secrets.
88
107
  See [Leveraging AI Assistance](https://github.com/IBM/aspera-cli/blob/main/docs/README.md#leveraging-ai-assistance) in the manual.
89
108
 
data/SECURITY.md CHANGED
@@ -31,6 +31,20 @@ Include in the report:
31
31
 
32
32
  Remove secrets (passwords, tokens, private keys) from logs and configuration files before you send them.
33
33
 
34
+ ## Response Process
35
+
36
+ 1. The report is acknowledged within 14 days.
37
+ 2. It is assessed with the [Scope](#scope) and the [Trust Model](#trust-model): the reporter is told whether it is accepted, and why if it is not.
38
+ 3. An accepted vulnerability is fixed in the next release, see [Supported Versions](#supported-versions).
39
+ The reporter is asked not to disclose it before this release.
40
+ 4. The release notes ([CHANGELOG.md](CHANGELOG.md)) describe the fix in section "Issues Fixed", with the CVE identifier when one is assigned.
41
+ They credit the reporter, with the name the reporter chooses, unless the reporter asks to remain anonymous.
42
+ 5. Disclosure:
43
+ - A report sent on GitHub is handled in a private GitHub security advisory.
44
+ After the release, the advisory is published with the fixed version, so that it is in the [GitHub Advisory Database](https://github.com/advisories).
45
+ - A report sent to IBM PSIRT is disclosed by IBM PSIRT (CVE, security bulletin).
46
+ A GitHub security advisory is published with the same information.
47
+
34
48
  ## Scope
35
49
 
36
50
  In scope: the Ruby gem `aspera-cli` (the `ascli` command), and how it interacts with IBM Aspera components.