Repository avatar
Other Tools
v4.29.0
active

aspera-cli

io.github.IBM/aspera-cli

Operate IBM Aspera products: transfers, packages, files and administration

Documentation

IBM Aspera CLI

The automation interface for IBM Aspera. From command line to AI agents.

Gem Version unit tests coverage CII Best Practices License

Hootput the Owl

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 ascp logs 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:

InterfaceUsage
Command lineInteractive administration and operations
Shell scripts, schedulers, CI/CDRepeatable automation and batch processing
Structured outputIntegration with applications, monitoring and pipelines
MCP server, agent skillAI assistants and AI agents

Get started

Install Ruby ≥ 3.3, then:

gem install aspera-cli
ascli transferd install
ascli -v

The 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.1

Watch 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 server

Each 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 skill 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.
  • 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.

MCP server setup: install the optional gem mcp with ascli (and rack for HTTPS), then declare the server in the MCP client (local, stdio):

gem install aspera-cli mcp
{
  "mcpServers": {
    "ascli": {
      "command": "ascli",
      "args": ["mcp", "server"]
    }
  }
}

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

ProductPluginWhat you can do
IBM Aspera on CloudaocFiles, packages, administration, Automation workflows
IBM Aspera Faspex 5faspex5Packages, shared inboxes, administration
IBM Aspera SharessharesFiles, administration
IBM Aspera High-Speed Transfer Serverserver, nodeTransfers over SSH, Node API, access keys, ascp logs
IBM Aspera ConsoleconsoleTransfers, administration
IBM Aspera OrchestratororchestratorWorkflows, work orders, plugins
IBM Cloud Object StoragecosTransfers to buckets
IBM Aspera HTTP GatewayhttpgwTransfer agent, health
IBM Aspera faspio GatewayfaspioBridges, health, metrics
IBM Aspera Transfer DaemontransferdInstall, run as a service, manage transfers

Documentation

ResourceLink
Documentation siteibm.github.io/aspera-cli (one page per section, llms.txt for AI assistants)
Online manualGitHub docs/README.md
PDF manualIn GitHub Releases
RubyGemsrubygems.org/gems/aspera-cli
RubyDocrubydoc.info/gems/aspera-cli
Docsifyonline

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

License

Open source, Apache-2.0, by IBM.

OCI
docker.io/martinlaurent/ascli:4.29.0
Install Command
docker pull docker.io/martinlaurent/ascli:4.29.0:undefined