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 items 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-jira-instance.atlassian.net
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.1.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.1-py3-none-any.whl (9.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: argocli-0.1.1.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.1.tar.gz
Algorithm Hash digest
SHA256 ea6678e3703d92afdc134cc9c57424e3733d927c01abf9918f014e596a412a4f
MD5 1cd06c3f26913f4c8f893a5e77b40dac
BLAKE2b-256 c8d0e7d30ed85c8a666679d8830bfd8c0315de235c03ab52d5ff53db78f07308

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: argocli-0.1.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 416d79d1916ba6b807bb1306f2504efb8d326bdbfceb96b6730f83f68fda34c6
MD5 669aab8bdda644f646e7c0577d940265
BLAKE2b-256 32629848f5e699751c0eba915895d558c50b893dd28e15ceaf9d07de56e73cbe

See more details on using hashes here.

Provenance

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