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.2.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.2-py3-none-any.whl (9.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: argocli-0.1.2.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.2.tar.gz
Algorithm Hash digest
SHA256 d5457b960a441a95a3d65cb21cb10fa2b99693ee76ce196712edc02dd9c819d9
MD5 661949fdd8099e54e9ae73ccd42058d6
BLAKE2b-256 7b3d390d675060966163fd43362643e9eb0bbaf37e8f65bf53046a9da51b0971

See more details on using hashes here.

Provenance

The following attestation bundles were made for argocli-0.1.2.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.2-py3-none-any.whl.

File metadata

  • Download URL: argocli-0.1.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 84552ea4254d3217998d90cc58f6e1c55e8d068d0ded4acffe454bc47ab5cca0
MD5 d2268005b12211df708d8d56eb1de9b5
BLAKE2b-256 cca57cdf9183bce95763538b8dfc684de511dcbe72fc32855741e4c14f07aa69

See more details on using hashes here.

Provenance

The following attestation bundles were made for argocli-0.1.2-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