Apheris Foundry CLI

Command-line interface for submitting and managing Foundry workflow runs on an Apheris Hub instance.

Requirements

• Python 3.10 or later
• Access to an Apheris Hub instance

Installation

conda

Recommended if you already use conda for scientific Python work. A dedicated environment avoids dependency conflicts.

Linux / macOS

conda create -n apherisfold python=3.11 -y
conda activate apherisfold
pip install apherisfold-cli

Windows (Anaconda Prompt or PowerShell)

conda create -n apherisfold python=3.11 -y
conda activate apherisfold
pip install apherisfold-cli

Activate the environment at the start of each session with conda activate apherisfold.

venv (standard Python)

Linux / macOS (venv)

python3 -m venv ~/.venvs/apherisfold
source ~/.venvs/apherisfold/bin/activate
pip install apherisfold-cli

Windows (PowerShell, venv)

python -m venv $env:USERPROFILE\.venvs\apherisfold
& $env:USERPROFILE\.venvs\apherisfold\Scripts\Activate.ps1
pip install apherisfold-cli

Activate the environment at the start of each session with the activate command above.

Verify

apheris-foundry --version
apheris-foundry --help

Upgrade

pip install --upgrade apherisfold-cli

Quick start

# Log in with your Apheris Hub URL
apheris-foundry login --url https://hub.example.com

# See available workflow definitions
apheris-foundry workflows list

# Submit a run
apheris-foundry workflows run --workflow predict --input ./request.json

# List submitted runs
apheris-foundry jobs list

# Filter by workflow
apheris-foundry jobs list --workflow predict

# Inspect a run
apheris-foundry jobs get --id <job-id>

# Stream logs
apheris-foundry jobs logs --id <job-id>

# Download results
apheris-foundry jobs download --id <job-id>

# Print the error for a failed run
apheris-foundry jobs error --id <job-id>

Command reference

Authentication

Workflow definitions (workflows)

Run instances (runs)

Use --help on any command for the full option reference and examples:

apheris-foundry workflows run --help
apheris-foundry jobs get --help

License

This package is licensed under the Apheris Foundry Software License. The full license text is also included in every published wheel as LICENSE.

Support

Contact support@apheris.com for access and deployment assistance.