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 emits human-readable text when stdout is a terminal and JSON when stdout is piped or redirected. Use --json to force JSON in a terminal, or --no-json to force text 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.1.tar.gz (53.5 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.1-py3-none-any.whl (60.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for galaxy_cli-1.0.1.tar.gz
Algorithm Hash digest
SHA256 c1b312cc8257476f23249c370a09e05faf4e07a5684a8b436978901fc7f139f5
MD5 a348280185d1a9a9b79b77640f5e125a
BLAKE2b-256 e9c45bbd058fe59c41a8ec17d9cae96bdf6d7668447c587a65bc338d9c135df2

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for galaxy_cli-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a937fb38817396f7d24d1b87c779d49e43ab6a70ff150912183de523bf937698
MD5 8263a9ab4bf5a480c4b13e95cdd18e91
BLAKE2b-256 01782f4914dc0a4300925c570a5c14a1e475b357366b18e2dd7eac21119b6965

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