ArmoniK CLI documentation

This repository is part of the ArmoniK project. It provides a command-line tool to monitor and manage ArmoniK clusters.

User Guide

• Installation
  • Requirements
  • Install from source
  • Install from PyPI
  • Connecting to Your ArmoniK Cluster
• Working with ArmoniK.CLI
  • Global Options
  • Configuration
  • Filters
  • Pagination and Sorting
  • Output Formats
• CLI Reference

Developer's Guide

• Working on ArmoniK.CLI
  • Configuring ArmoniK.CLI for development
    • Requirements
    • Installation
    • Running tests
    • Linting and formatting
    • Documentation
  • Using ArmoniK.CLI with a custom version of ArmoniK Python API
  • Extension support
• ArmoniK.CLI Core
  • Serialization of ArmoniK types
• API Reference
  • armonik_cli
    • armonik_cli package