Welcome to ak’s Documentation!¶

Table of Contents:

  • Introduction
    • Key Features
    • Why Use ak?
  • Quick Start
    • Installation
    • Generating Shell Completion
    • Basic Usage
    • Prompt & Environment Variables
  • Usage Guide
    • Overview
    • Examples
    • Multiple Kubeconfigs & Namespaces
    • Automatic or On-Demand Token Refresh
  • Configuration
    • Overview
    • Global Structure
    • [aws] Section
    • [aws.<profile>] Sub-Profiles
    • [kube] Section
    • Minimal Default Config
    • Tips & Best Practices
    • Conclusion
  • Commands
    • ak l
    • ak c
    • ak x
    • ak r
    • ak completion
  • API Reference
    • AKConfig
    • AWSManager
    • KubeManager
    • setup_logger()
    • complete_aws_profile()
    • complete_context_name()
    • complete_kube_name()
    • generate_bash_zsh_prompt_script()
    • generate_bash_zsh_wrapper()
    • generate_custom_wrapper()
    • generate_fish_prompt_script()
    • generate_fish_wrapper()
    • generate_prompt_script()
    • get_official_completion()
    • get_shell_mode()
    • main()

Indices and tables¶

  • Index

  • Module Index

  • Search Page

ak

Navigation

Table of Contents:

  • Introduction
  • Quick Start
  • Usage Guide
  • Configuration
  • Commands
  • API Reference

Related Topics

  • Documentation overview
    • Next: Introduction
©2025, Aharon Haravon. | Powered by Sphinx 8.1.3 & Alabaster 1.0.0 | Page source