Inductiva CLI

The Inductiva CLI helps you interact with the Inductiva API directly from the terminal, enabling you to manage computational resources, tasks, and much more.

This section documents every command and flag available in Inductiva's command-line interface (CLI).

CLI Command Overview

The table below shows the available CLI commands alongside their corresponding Python Client APIs and documentation guide. Most functionality is available through both interfaces, allowing you to choose the tool that best fits your workflow. The CLI is ideal for quick operations, while the Python Client offers a more programmatic control and integration with your code.

For detailed guidance on when to use each interface and how they work together, see our Interfaces with the API guide.

Notes

• Use --help with any command for more detailed usage and available flags.
• For safety, commands like resources terminate and containers remove include a --yes flag to bypass confirmation prompts.

Set Up & Authentication

The CLI is automatically installed when you install Inductiva’s Python Client. However, before using the CLI, you need to authenticate with your Inductiva account.

inductiva auth login

When prompted, copy paste your personal API key that is available from your User Account page in the Web Console.

     ___  _   _  ____   _   _   ____  _____  ___ __     __ _
    |_ _|| \ | ||  _ \ | | | | / ___||_   _||_ _|\ \   / // \
     | | |  \| || | | || | | || |      | |   | |  \ \ / // _ \
     | | | |\  || |_| || |_| || |___   | |   | |   \ V // ___ \
    |___||_| \_||____/  \___/  \____|  |_|  |___|   \_//_/   \_\
    
    To log in, you need an API Key. You can obtain it from your account at https://console.inductiva.ai/account.
    Please paste your API Key here:

Need Help?

Use the --help or -h flag with any command for more details:

inductiva tasks --help