localargo 0.1.3

No project description provided

localargo

Convenient ArgoCD local development tool

Localargo is a command-line tool that makes ArgoCD development workflows faster and more convenient. It provides streamlined commands for managing local clusters, applications, secrets, port forwarding, and debugging - all designed specifically for ArgoCD development.

Features

• 🚀 Cluster Management: Initialize, manage, and switch between Kubernetes clusters
• 📦 Application Management: Create, sync, and manage ArgoCD applications
• 🌐 Port Forwarding: Easily access services running in your applications
• 🔐 Secrets Management: Create and manage secrets for local development
• 🔄 Sync Operations: Sync applications with watch mode for continuous development
• 📋 Templates: Quick-start applications from common templates
• 🔍 Debug Tools: Comprehensive debugging and troubleshooting utilities
• 📋 Validation: Validate configurations before deployment

Quick Start

# Install localargo
pip install localargo

# Initialize a local cluster with ArgoCD (uses KinD by default)
localargo cluster init

# Bring up cluster, configure ArgoCD, apply secrets, deploy apps
localargo up

# Create an application from a template
localargo template create my-app --repo https://github.com/myorg/myrepo

# Port forward services for easy access
localargo port-forward start my-service

# Sync and watch for changes
localargo sync --app my-app --watch

Available Commands

Localargo provides the following main commands:

• cluster: Manage Kubernetes clusters for ArgoCD development

  • init: Initialize a local cluster with ArgoCD
  • status: Show cluster and ArgoCD status
  • list: List available clusters
  • switch: Switch Kubernetes contexts
  • delete: Delete clusters
  • password: Get ArgoCD admin password

• up: Bring up cluster, configure ArgoCD, apply secrets, deploy apps

• app: Manage ArgoCD applications

  • deploy: Create/update and sync applications
  • sync: Sync applications
  • status: Show application status
  • logs: Tail application logs
  • list: List applications
  • delete: Delete applications

• sync: Sync ArgoCD applications or local directories (with watch mode)

• template: Create ArgoCD applications from templates

  • create: Create application from template
  • list-templates: List available templates
  • show: Show template details

• port-forward: Manage port forwarding for applications

  • start: Start port forwarding for a service
  • app: Port forward all services in an application
  • list-forwards: List active forwards
  • stop: Stop port forwarding

• secrets: Manage secrets for local development

• debug: Debugging and troubleshooting tools

  • validate: Validate application configuration
  • logs: Show ArgoCD application logs
  • events: Show Kubernetes events

• validate: Validate manifest and show execution plan

• down: Tear down cluster

Table of Contents

• Installation
• Documentation
• License

Installation

pip install localargo

Development Setup

For contributors and development, we recommend using Mise to set up the complete development environment:

# Install Mise (macOS with Homebrew)
brew install mise

# Install all development tools
mise install

# Create Hatch environment
hatch env create

# All tools will be automatically available

🧩 Git Hook Setup

To ensure code quality before every commit, enable the mise-managed pre-commit hook:

mise generate git-pre-commit --write --task=precommit

This creates .git/hooks/pre-commit, which automatically runs:

• hatch fmt
• hatch run typecheck
• hatch run test

If any step fails, the commit will be blocked until fixed.

You can also run it manually at any time:

mise run precommit

Optional Dependencies

For file watching functionality:

pip install localargo[watch]

Documentation

📖 Full documentation is available at docs/ and can be built locally using mdBook.

To build the documentation:

# Install mdBook (if not already installed)
cargo install mdbook

# Build the docs
cd docs && mdbook build

# Or using Hatch
hatch run docs:build

License

localargo is distributed under the terms of the MIT license.