Skip to main content

A command-line interface for Argo Workflows

Project description

Argo CLI

A command-line interface for interacting with Argo.

This project uses UV for dependency management.

Installation

pip install argocli

Authentication

On first-run, you'll be prompted for an Argo API token. This will be stored in your system credential store (e.g. Keychain on Mac OS) in an item called argocli.

Configuration

On first-run, a configuration file will be generated at ~/.config/argocli/config.yaml. In this file you'll need to replace the values of server, namespace, and username with appropriate values.

server: https://your-argo-instance.server.tld
namespace: YOUR_PROJECT_NAMESPACE
username: your.email@example.com

Usage

The Argo CLI follows a command-action pattern for all operations:

argocli <command> <action> [options]

Global Options

  • --verbose: Enable debug output
  • --help: Show command help

Examples

Workflow Commands

Show the status of a workflow:

argocli workflow status -n WORKFLOW_NAME

Development

Setup Development Environment

# Install dependencies including dev dependencies
uv sync

# Activate the venv
source .venv/bin/activate

# Run tests
uv run pytest

Please note that tests are still WIP

Project Structure

  • argocli/commands/ - Command implementations
    • workflow/ - Workflow-related commands
  • argocli/cli/ - CLI entry point and argument parsing

Adding New Commands

  1. Create a new action module in the appropriate command directory.
  2. Define a class that inherits from the command's base class.
  3. Implement define_arguments() and execute() methods.

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

argocli-0.1.4.tar.gz (8.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

argocli-0.1.4-py3-none-any.whl (9.2 kB view details)

Uploaded Python 3

File details

Details for the file argocli-0.1.4.tar.gz.

File metadata

  • Download URL: argocli-0.1.4.tar.gz
  • Upload date:
  • Size: 8.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for argocli-0.1.4.tar.gz
Algorithm Hash digest
SHA256 1e8249e0cebe8272c3172a930aff287f8f369fe6f495db1eca69c0bfe05a6691
MD5 4e5cac1b267212c345e3d919a7db2838
BLAKE2b-256 21d106a50908312a5317b19911d44bfecaddf664f220d2f2352e30d87fd8ae9d

See more details on using hashes here.

Provenance

The following attestation bundles were made for argocli-0.1.4.tar.gz:

Publisher: create_artifacts_and_publish.yaml on rpunt/argocli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file argocli-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: argocli-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 9.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for argocli-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 70bda3b5156013f2478cbca88f546bc105accef37a39583d375fee47fa9db5fc
MD5 5f4ec7af3d36f490d4c399ee46744b37
BLAKE2b-256 2e24d20c1182b1b0ad9dec8362ef6b6d1ed97fa449a9bf991e9351ace51e4ac9

See more details on using hashes here.

Provenance

The following attestation bundles were made for argocli-0.1.4-py3-none-any.whl:

Publisher: create_artifacts_and_publish.yaml on rpunt/argocli

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