Skip to main content

CLI harness for the Galaxy bioinformatics platform

Project description

galaxy-cli

CLI harness for the Galaxy bioinformatics platform. It wraps Galaxy's REST API to provide command-line and REPL access to histories, datasets, tools, workflows, jobs, and libraries.

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

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
python3 -m pip install galaxy-cli

For local development from this repository:

python3 -m pip install .

Verify installation:

which galaxy-cli
galaxy-cli --version

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

galaxy-cli history list
galaxy-cli history create "My Analysis"
galaxy-cli tool search "bowtie"
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.

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.1.0.tar.gz (62.3 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.1.0-py3-none-any.whl (66.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: galaxy_cli-1.1.0.tar.gz
  • Upload date:
  • Size: 62.3 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.1.0.tar.gz
Algorithm Hash digest
SHA256 34a2b25ff942dc573ce5046d7f34c5f79afb93d35e701a9f487c8cc6272beb03
MD5 b71847cdee5497fb54bf0093bc1a28ad
BLAKE2b-256 c9e1708641190555e7a6b7d2ad09fd474e3f69b1f7bef96b9c8d56089978d658

See more details on using hashes here.

Provenance

The following attestation bundles were made for galaxy_cli-1.1.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.1.0-py3-none-any.whl.

File metadata

  • Download URL: galaxy_cli-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 66.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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8c03b1b77ce9863ce9d987441d0f991102c503240cdcdc34493f3a171c3c5aed
MD5 45cbd0239b2e4ab3bd45c9b7639ebecd
BLAKE2b-256 9c75c765775e12d85033a2f8639bf42f975c68fe5ce8e8b15728f70c78b1faba

See more details on using hashes here.

Provenance

The following attestation bundles were made for galaxy_cli-1.1.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