InOrbit CLI

Welcome to the InOrbit Command Line Interface (CLI) - a powerful tool for managing robot configurations as code on the InOrbit Cloud platform.

Overview

The InOrbit CLI enables you to interact with the InOrbit Cloud platform programmatically, allowing you to:

• Manage robot configurations as code
• Apply, compare, and delete configurations
• Query robot, tag, and collection information
• Evaluate expressions on robots
• List and describe various InOrbit resources

Installing

The package is available on PyPI.

Note: Make sure you have deactivated any development virtual environment or are using a different one with no inorbit python package installed.

pip install inorbit-cli

Requirements

• Python 3.12 or higher
• An InOrbit API key (see Usage section)

Usage

Authentication

The CLI requires an API key for authenticating against InOrbit's platform. To obtain an API key:

1. Go to the InOrbit control panel
2. Navigate to Settings > Admin section > API Keys tab
3. Generate or copy your API key

Set the API key as an environment variable:

export INORBIT_CLI_API_KEY="your_api_key_here"

Basic Commands

Get help and see all available commands:

inorbit --help

Enable verbose output for debugging:

inorbit --verbose
# or
export INORBIT_CLI_VERBOSE="true"

Configuration Management

Apply configurations from a file or directory:

inorbit apply -f config.yaml

Compare configurations without applying:

inorbit apply -f config.yaml --compare

Apply without confirmation prompts:

inorbit apply -f config.yaml -y

List configurations:

inorbit get config --kind IncidentDefinition

Delete a configuration:

inorbit delete config <config_id> --kind IncidentDefinition

Resource Queries

Get robots:

inorbit get robots

Describe robots with detailed information:

inorbit describe robots

Get tags:

inorbit get tags

Describe collections:

inorbit describe collections

Expression Evaluation

Evaluate expressions on robots:

inorbit expr eval <robot_id> "expression_here"

Or use a file:

inorbit expr eval <robot_id> -f expression.yaml

Persistent configuration:

Add these to your shell startup file (~/.bashrc, ~/.zshrc, etc.):

export INORBIT_CLI_API_KEY="your_api_key_here"
export INORBIT_CLI_VERBOSE="false"  # optional

Development

For development setup and contribution guidelines, see CONTRIBUTING.md.

License

Proprietary - Copyright (c) 2021, InOrbit, Inc. All rights reserved.

Support

For issues, questions, or contributions, please refer to the contributing guide or contact support@inorbit.ai.