IBM Aspera CLI
OfficialIBM Aspera CLI
The automation interface for IBM Aspera. From command line to AI agents.
ascli is an open-source toolkit to automate, integrate and operate IBM Aspera products.
Administrators, developers, integration engineers and AI agents use the same consistent interface to the whole Aspera ecosystem.
What can you do with ascli?
Transfer: run high-speed FASP transfers, with the transfer agent of your choice (
ascp, Transfer Daemon, IBM Aspera for Desktop, HTTP Gateway, Node API).Automate: script transfers, packages, file management, administration and operational workflows.
Integrate: call Aspera REST APIs as commands, with JSON, YAML, CSV or table output, filtered with JMESPath.
Operate: Aspera on Cloud, Faspex, Shares, Node API, High-Speed Transfer Server, Console, Orchestrator, Cloud Object Storage.
Configure: reusable presets per environment, secrets in a vault, never in scripts.
Diagnose: analyze
ascplogs to find why a transfer failed or is slow.Use AI: let AI assistants and agents operate Aspera, in a shell or through the MCP server, without seeing secrets.
One interface, several ways to use it:
Interface | Usage |
Command line | Interactive administration and operations |
Shell scripts, schedulers, CI/CD | Repeatable automation and batch processing |
Structured output | Integration with applications, monitoring and pipelines |
MCP server, agent skill | AI assistants and AI agents |
Related MCP server: ssh-mcp-server
Get started
Install Ruby ≥ 3.3, then:
gem install aspera-cli
ascli transferd install
ascli -vThe second command installs the FASP transfer engine (ascp).
No Ruby? Use the single executable, the Linux or Windows portable package, Chocolatey or the container image: see Installation.
Try it in 60 seconds
No account needed: the public Aspera demo server is configured for you.
ascli config initdemo
ascli server browse /
ascli server download /aspera-test-dir-small/10MB.1Watch it first: IBM Aspera in 60 seconds (video, 1 min 23 s), more demos on the Aspera CLI YouTube channel.
Examples
# Upload 1 GB of generated data (no local file needed), at 500 Mbps maximum
ascli server upload 'faux:///test1g?1g' --to-folder=/Upload --ts.target_rate=500m
# Browse files in Aspera on Cloud
ascli aoc files browse /
# List packages in Faspex 5, as JSON for a script
ascli faspex5 packages list --format=json
# Diagnose transfers from ascp log files
ascli config ascp logs diagnostics /var/log/aspera.log
# Let an AI assistant operate Aspera
ascli mcp serverEach product has its own plugin (aoc, faspex5, shares, node, server, console, orchestrator, cos...).
ascli <plugin> -h lists its commands.
Use with AI assistants
ascli lets AI assistants and AI agents (LLM) operate IBM Aspera products for you, with the same commands, presets and secrets as you:
In a shell (coding agents): nothing to set up. Give the agent
llms.txt, or install the agent skillskills/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.MCP server (Model Context Protocol):
ascli mcp serverexposes all commands to any MCP client (IBM Bob, Claude, VS Code...), locally or over HTTPS with token or OAuth authentication.
Safe by default: in the MCP server, the AI can neither execute code nor write files where it chooses, and never sees secrets. See Leveraging AI Assistance in the manual.
Supported products
Product | Plugin | What you can do |
IBM Aspera on Cloud |
| Files, packages, administration, Automation workflows |
IBM Aspera Faspex 5 |
| Packages, shared inboxes, administration |
IBM Aspera Shares |
| Files, administration |
IBM Aspera High-Speed Transfer Server |
| Transfers over SSH, Node API, access keys, |
IBM Aspera Console |
| Transfers, administration |
IBM Aspera Orchestrator |
| Workflows, work orders, plugins |
IBM Cloud Object Storage |
| Transfers to buckets |
IBM Aspera HTTP Gateway |
| Transfer agent, health |
IBM Aspera faspio Gateway |
| Bridges, health, metrics |
IBM Aspera Transfer Daemon |
| Install, run as a service, manage transfers |
Documentation
Resource | Link |
Documentation site | ibm.github.io/aspera-cli (one page per section, llms.txt for AI assistants) |
Online manual | |
PDF manual | |
RubyGems | |
RubyDoc | |
Docsify |
For debugging, use --log-level=debug.
Trust
ascli is used to operate production systems, so the project follows strict practices: OpenSSF Best Practices silver badge, high test coverage, a security assurance case, and secrets kept out of commands and AI clients.
For security and compliance reviews, see Security and Trust in the manual.
Contributing
Questions, ideas, show and tell: GitHub Discussions
Bugs & features: BUGS.md
Security vulnerabilities: SECURITY.md
How to contribute: CONTRIBUTING.md
Code of conduct: CODE_OF_CONDUCT.md
Governance: GOVERNANCE.md
Release notes: CHANGELOG.md
License
Open source, Apache-2.0, by IBM.
Available Tools
1 toolexecute_ascli_commandA
Execute any ascli (Aspera CLI) command in-process and return its result.
COMMAND DISPLAY (MANDATORY)
Whenever you execute an ascli command or present its results, you MUST ALWAYS explicitly
show the equivalent command line in your response to the user as bash syntax
(e.g. ascli plugin command --option=value).
SYNTAX args is a JSON array of strings mirroring the CLI command line. Element 0 : plugin name (aoc, faspex5, node, server, config, …). Elements 1+: sub-commands, positional arguments, and --option=value flags in any order. Structured values use an extended-value prefix on the relevant element: "@json:{...}" — inline JSON object or array (preferred: no shell quoting) "@preset:name" — expand a saved preset "@base64:..." — base64-encoded value "@val:..." — literal string (no further decoding) "@secret:name" — secret entered by the user on a web page, never visible to you: use it for a secret the user did not give, e.g. "--password=@secret:password" Note: @stdin: is disabled; @ruby:, @file:, @uri:, @env: depend on the security level of the server. A secret (from @secret:, @vault:, @preset:) must be the whole value: no other prefix before it, not in @extend:.
AUTOMATIC FLAGS The server prepends extra_args to every call (default: --interactive=no --transfer.asynchronous=true). Do NOT repeat them. To override one, include it in args: later values take precedence. Commands never prompt: if credentials are missing, an error is returned; report it and stop.
DISCOVERY — never guess command or field names from training data Step 1 — commands of a plugin, with syntax: ["config", "commands", ""] Returns { syntax, description } for every command of that plugin. Notation: mandatory, [] optional, <a|b> enum, <arg...> variadic, arg:Hash typed. A line ending with <command...> and "(see: )" provides the commands of that path: list them with ["config", "commands", "", "", ...] (command words only). Omit to list the commands of all plugins (large). Step 2 — schema of a Hash argument (shown name:Hash), MANDATORY before calling such a command: ["", "", ..., "help"] Put the literal "help" in place of the Hash argument. Returns field names, types, required flags and descriptions. Never infer fields from server error messages. Step 2b — filter parameters of a list command: ["", "", ..., "--query=help"] Step 3 — all --flags of a plugin, with allowed values: ["config", "options", ""] Documentation: ["config", "documentation", "toc"] → { level, title, anchor } per heading ["config", "documentation", "local", ""] → one README section Presets (saved credentials): ["config", "preset", "overview"]
RESULT FORMAT Structured data is always in structuredContent (a JSON object; lists are under "items"). For lists, text content is limited to 100000 bytes (whole items only); when truncated, a WARNING line gives the real total. Read structuredContent.items for the full dataset — never report counts or search results from a truncated text block.
FILE LIST FOR TRANSFERS For all transfers (upload, download, package send, …), append source paths at the end of args — no --sources flag needed.
EXAMPLES ["config", "commands", "aoc"] ["aoc", "admin", "user", "create", "help"] ["config", "options", "aoc"] ["config", "documentation", "local", "leveraging-ai-assistance"] ["aoc", "--preset=myaoc", "packages", "list"] ["aoc", "--preset=myaoc", "admin", "user", "create", '@json:{"email":"a@b.com","name":"Alice"}'] ["aoc", "--preset=myaoc", "packages", "send", '@json:{"name":"pkg","recipients":["user@example.com"]}', "/local/a.txt", "/local/b.txt"] ["server", "--preset=myserver", "upload", "--to-folder=/uploads", "/local/a.txt"] ["server", "browse", "/", "--url=ssh://host:33001", "--username=user", "--password=secret"]
Inputs: args (required).
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 1 tool
There is only one tool, so there is no possibility of selecting the wrong one. Its single purpose — run an ascli argv array — is clearly stated and matches its name.
A single tool named execute_ascli_command uses a clean verb_noun convention and is self-describing. With one tool there is no convention mixing to penalize.
A single generic passthrough tool is a defensible design for a large CLI, but it is coarse: agents get no first-class operations and must chain discovery calls before anything. The surface is thin at the tool layer even though the underlying command space is large.
Because it delegates to the full ascli with built-in introspection of commands, options, argument schemas, and docs, virtually every CLI capability is reachable. The gap is ergonomic rather than functional: common workflows (upload, browse, package send) require multi-step discovery instead of dedicated tools.
Maintenance
Related MCP Connectors
Build and run AI workflows, agents, data tables and 1000+ API integrations from any MCP client.
Automate 1,000+ services from any MCP-compatible AI agent: build Applets, run actions and queries.
Reach your own computers from any AI app: files, search, commands, approvals and outage alerts.
Build and run agents and automations across hundreds of apps using natural language.
Related MCP Servers
- AlicenseNot gradedqualityBmaintenanceAI-powered connection manager with 60+ MCP tools for SSH terminal execution, RDP desktop control, VNC interaction, web session automation, and encrypted credential vault management. Works with Claude Code, Cursor, Windsurf, and any MCP-compatible client.305 npm20Apache 2.0
- AlicenseNot gradedqualityDmaintenanceEnables SSH command execution, file uploads/downloads, and multi-server management with zero-config inline credentials, supporting async jobs and AI-readable output.32 npm2AGPL 3.0
- AlicenseNot gradedqualityCmaintenanceEnables AI agents to interact with IBM i (AS/400) systems for RPA automation via 37 tools for 5250 navigation, CL commands, DB2 queries, and system management.MIT
- AlicenseAqualityBmaintenanceLets AI clients execute shell commands and transfer files on remote machines via configured aliases, while keeping credentials and audit logs local.8MIT