This release is a pre-release and may not be stable for production use.
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 runs list
# Filter by workflow
apheris-foundry runs list --workflow predict
# Inspect a run
apheris-foundry runs get --id <run-id>
# Stream logs
apheris-foundry runs logs --id <run-id>
# Download results
apheris-foundry runs download --id <run-id>
# Print the error for a failed run
apheris-foundry runs error --id <run-id>
Command reference
Authentication
| Command | Description |
|---|---|
apheris-foundry login |
Log in to a Hub instance |
apheris-foundry logout |
Log out of the current session |
Workflow definitions (workflows)
| Command | Description |
|---|---|
apheris-foundry workflows list |
List workflow definitions exposed by Hub |
apheris-foundry workflows get --workflow <id> |
Inspect one workflow definition |
apheris-foundry workflows graph --workflow <id> |
Show the workflow DAG |
apheris-foundry workflows run --workflow <id> |
Submit a workflow run |
Run instances (runs)
| Command | Description |
|---|---|
apheris-foundry runs list [--workflow <id>] |
List submitted runs |
apheris-foundry runs get --id <run-id> |
Inspect a run and its artifacts |
apheris-foundry runs logs --id <run-id> |
Print logs for a run |
apheris-foundry runs error --id <run-id> |
Print the saved error for a failed run |
apheris-foundry runs download --id <run-id> |
Download results for a completed run |
Use --help on any command for the full option reference and examples:
apheris-foundry workflows run --help
apheris-foundry runs 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.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file apheris_foundry_cli-0.1.0rc1.tar.gz.
File metadata
- Download URL: apheris_foundry_cli-0.1.0rc1.tar.gz
- Upload date:
- Size: 74.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3520a8b8c2ea5facd612b26b78a9df91e0f729fb9ede3526c28afaf95d1746dd
|
|
| MD5 |
7f2122a2cffa2c878f5160c26f0069fd
|
|
| BLAKE2b-256 |
d272015b16a1843d2cacb61c09cbf937be77140fabeaecc9fb582d2a17f644b8
|
Provenance
The following attestation bundles were made for apheris_foundry_cli-0.1.0rc1.tar.gz:
Publisher:
release.yaml on apheris/apheris-foundry-cli
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
apheris_foundry_cli-0.1.0rc1.tar.gz -
Subject digest:
3520a8b8c2ea5facd612b26b78a9df91e0f729fb9ede3526c28afaf95d1746dd - Sigstore transparency entry: 2617069364
- Sigstore integration time:
-
Permalink:
apheris/apheris-foundry-cli@c1e72fb3072dd8bde48f89a8c3590cf552da3119 -
Branch / Tag:
refs/tags/v0.1.0rc1 - Owner: https://github.com/apheris
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yaml@c1e72fb3072dd8bde48f89a8c3590cf552da3119 -
Trigger Event:
push
-
Statement type:
File details
Details for the file apheris_foundry_cli-0.1.0rc1-py3-none-any.whl.
File metadata
- Download URL: apheris_foundry_cli-0.1.0rc1-py3-none-any.whl
- Upload date:
- Size: 54.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1abdf670c0f203f0468994fc15c563b29020d75b52ac49034bc077cd01b2f80f
|
|
| MD5 |
de70bf6524a9c8016036eae5c910033c
|
|
| BLAKE2b-256 |
e3b978288291ec7c5384a231ce7779cb2d17bfb4ad3145e27e21fe50376e0331
|
Provenance
The following attestation bundles were made for apheris_foundry_cli-0.1.0rc1-py3-none-any.whl:
Publisher:
release.yaml on apheris/apheris-foundry-cli
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
apheris_foundry_cli-0.1.0rc1-py3-none-any.whl -
Subject digest:
1abdf670c0f203f0468994fc15c563b29020d75b52ac49034bc077cd01b2f80f - Sigstore transparency entry: 2617069433
- Sigstore integration time:
-
Permalink:
apheris/apheris-foundry-cli@c1e72fb3072dd8bde48f89a8c3590cf552da3119 -
Branch / Tag:
refs/tags/v0.1.0rc1 - Owner: https://github.com/apheris
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yaml@c1e72fb3072dd8bde48f89a8c3590cf552da3119 -
Trigger Event:
push
-
Statement type:
