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.
- 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 |
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.
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.1# 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.
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 install ascli --marketplace IBM/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.
| Product | Plugin | What you can do |
|---|---|---|
| IBM Aspera on Cloud | aoc |
Files, packages, administration, Automation workflows |
| IBM Aspera Faspex 5 | faspex5 |
Packages, shared inboxes, administration |
| IBM Aspera Shares | shares |
Files, administration |
| IBM Aspera High-Speed Transfer Server | server, node |
Transfers over SSH, Node API, access keys, ascp logs |
| IBM Aspera Console | console |
Transfers, administration |
| IBM Aspera Orchestrator | orchestrator |
Workflows, work orders, plugins |
| IBM Cloud Object Storage | cos |
Transfers to buckets |
| IBM Aspera HTTP Gateway | httpgw |
Transfer agent, health |
| IBM Aspera faspio Gateway | faspio |
Bridges, health, metrics |
| IBM Aspera Transfer Daemon | transferd |
Install, run as a service, manage transfers |
| Resource | Link |
|---|---|
| Documentation site | ibm.github.io/aspera-cli (one page per section, llms.txt for AI assistants) |
| Online manual | GitHub docs/README.md |
| PDF manual | In GitHub Releases |
| RubyGems | rubygems.org/gems/aspera-cli |
| RubyDoc | rubydoc.info/gems/aspera-cli |
| Docsify | online |
For debugging, use --log-level=debug.
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.
- 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
Open source, Apache-2.0, by IBM.