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

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.0.2.tar.gz (53.2 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.0.2-py3-none-any.whl (59.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: galaxy_cli-1.0.2.tar.gz
  • Upload date:
  • Size: 53.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.10

File hashes

Hashes for galaxy_cli-1.0.2.tar.gz
Algorithm Hash digest
SHA256 528e218a71826d68ce1606149f5406da6a9c93e171b69fc60c63b8a06afc7b24
MD5 4adadc3c5ecca91e178fdfff46343cb7
BLAKE2b-256 45791ff402e2291e9ac737a786c17e19a82e656d016f4db1709ac3af3c1a68e2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: galaxy_cli-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 59.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.10

File hashes

Hashes for galaxy_cli-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 585f9e53c067ed69bd4eed19be0e0273005cc2bc5328d82045e18ac3060e9495
MD5 997412dd1d5a75f306d607238ce33b58
BLAKE2b-256 36992ab0942be36437f913156966374709cf8f83ab74fb6edb9f9f3d6643708a

See more details on using hashes here.

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