ArmoniK CLI

Table of Contents

• Overview
• Installation
  • Recommended Installation (pipx)
  • Alternative Installation Methods
  • Development Installation
• Getting Started
• Documentation
• Contributing
• License

Overview

The ArmoniK CLI is a tool that provides commands to monitor and manage computations in ArmoniK clusters. It serves as a powerful alternative to the ArmoniK Admin GUI, offering the same core functionality through a terminal interface.

The CLI enables users to:

• Manage results, sessions and partitions.
• Monitor task execution.
• Query task results and metadata.

A key advantage of the CLI is its ability to support automation through scripts and scheduled jobs. This makes it ideal for DevOps workflows, automated testing, and continuous integration/deployment pipelines where GUI interaction is not practical.

Installation

Recommended Installation (pipx)

We recommend using pipx to install the CLI in an isolated environment:

pipx install armonik-cli

You can check the installation by running:

armonik --version

Alternative Installation Methods

Alternatively, you can install the CLI using pip or from source.

Using pip

pip install armonik-cli

You can check the installation by running:

armonik --version

From source

git clone https://github.com/aneoconsulting/ArmoniK.CLI.git
cd ArmoniK.CLI
pip install -e .

You can check the installation by running:

armonik --version

Development Installation

If you want to contribute to the project, follow the steps for installing from source and add the [dev,tests] extra:

pip install -e .[dev,tests]

You can check the installation by running:

armonik --version

Getting Started

To use the CLI with an ArmoniK cluster, you must provide the CLI with the cluster credentials. The most simple way to do this is to use the --endpoint option:

armonik --endpoint <cluster-endpoint> cluster info

There exists additional options to connect to clusters that use TLS. In addition, to simplify the usage of the CLI, you can set the default values for the --endpoint and the others connection options using a configuration file.

You don't need to specify the endpoint if you exported the AKCONFIG variable when prompted to when deploying an ArmoniK cluster, because that environment variable points to a pre-filled configuration.

To list available commands and options, you can use the --help or -h option:

armonik --help

To learn more about the CLI, please refer to the documentation.

Documentation

The full documentation is available on ReadTheDocs. Otherwise, you can build and view the documentation locally by running:

pip install -e .[docs]
sphinx-autobuild docs _build/html

Contributing

We welcome contributions! Please see our Contributing Guide for more information.

License

This project is licensed under the Apache 2.0 License.