Skip to main content

Galaxy bioinformatics CLI for automating histories, datasets, tools, workflows, and jobs via the Galaxy REST API

Project description

galaxy-cli — Galaxy bioinformatics command-line client

galaxy-cli is a Python CLI and REPL for automating the Galaxy bioinformatics platform from the shell. It wraps the Galaxy REST API for histories, datasets, collections, tools, workflows, jobs, and libraries.

This project was initially generated with cli-anything and then refined into the standalone galaxy-cli package.

pip install galaxy-cli

What can galaxy-cli do?

galaxy-cli is a Galaxy bioinformatics CLI for users who want a Galaxy command-line client that works naturally in shell scripts and reproducible Galaxy analyses. You can use it to:

  • run Galaxy workflows from the command line and submit individual Galaxy tools
  • upload and download datasets
  • create and manage histories and collections
  • inspect jobs, logs, tools, and workflow metadata
  • automate Galaxy workflows for reproducible Galaxy bioinformatics analyses

Prerequisites

  • Python 3.9+
  • A running Galaxy server
  • A Galaxy API key from your target instance

Installation

Install from PyPI with uv or pip:

uv tool install galaxy-cli
pip install galaxy-cli

For local development from this repository:

python3 -m pip install .

Verify installation:

which galaxy-cli
galaxy-cli --version

AI Agent Skill

The package includes a galaxy-cli skill for Codex and Claude Code so agents can use the CLI without rediscovering command syntax.

# Install for Codex: ~/.codex/skills/galaxy-cli/SKILL.md
galaxy-cli skill install --agent codex

# Install for Claude Code: ~/.claude/skills/galaxy-cli/SKILL.md
galaxy-cli skill install --agent claude

Use galaxy-cli skill path to find the packaged skill, or galaxy-cli skill install --target-dir /path/to/skills for another agent or project-level skills directory.

Configuration

Set your Galaxy server URL and API key:

export GALAXY_URL=https://usegalaxy.org
export GALAXY_API_KEY=your-api-key

galaxy-cli config test

Session state is stored in ~/.galaxy-cli/session.json. It is intended for a single active writer; for parallel automation or multiple concurrent agents, pass --history-id explicitly instead of relying on shared session state.

Usage

Documentation site: https://qchiujunhao.github.io/galaxy-cli/

galaxy-cli history list
galaxy-cli history create "My Analysis"
galaxy-cli tool search "bowtie" --limit 5
galaxy-cli workflow list
galaxy-cli workflow list | jq .
galaxy-cli --human config show

galaxy-cli defaults to compact JSON output. Use --human for human-readable terminal output.

For large dataset uploads, use --upload-timeout to control the HTTP POST separately from the upload job wait. GALAXY_CLI_REQUEST_TIMEOUT controls regular API request reads, and GALAXY_CLI_UPLOAD_TIMEOUT controls uploads.

Run the REPL:

galaxy-cli

Tests

python3 -m pytest galaxy_cli/tests/ -v

Releases

Releases are published from GitHub Releases through PyPI Trusted Publishing. See RELEASE.md for the one-time PyPI setup and release checklist.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

galaxy_cli-1.3.0.tar.gz (80.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

galaxy_cli-1.3.0-py3-none-any.whl (78.8 kB view details)

Uploaded Python 3

File details

Details for the file galaxy_cli-1.3.0.tar.gz.

File metadata

  • Download URL: galaxy_cli-1.3.0.tar.gz
  • Upload date:
  • Size: 80.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for galaxy_cli-1.3.0.tar.gz
Algorithm Hash digest
SHA256 8e721e0e48da299233eaa010c8f09ff52e476b9685a5c8bab4541ad00b85c4af
MD5 189f7d79c3efa2f08fcf767e158bfe1d
BLAKE2b-256 8d960c74e9d51e62e6f06eb8518e8d1d9e4319f1f2e2f1007145c50e6c06d176

See more details on using hashes here.

Provenance

The following attestation bundles were made for galaxy_cli-1.3.0.tar.gz:

Publisher: release.yml on qchiujunhao/galaxy-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file galaxy_cli-1.3.0-py3-none-any.whl.

File metadata

  • Download URL: galaxy_cli-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 78.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for galaxy_cli-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f706dc8a117204195b273d2797a2db9b02fa12fc5270896c254eefdea818f63e
MD5 b2b39a8f0d48e814c84d6ad937866372
BLAKE2b-256 6148a9548d4752e478bebed6899296b1fd97600c5d98bdaa7f433f196b656ef8

See more details on using hashes here.

Provenance

The following attestation bundles were made for galaxy_cli-1.3.0-py3-none-any.whl:

Publisher: release.yml on qchiujunhao/galaxy-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page