ipctl

A CLI tool for managing and interacting with the Itential Platform

A CLI for managing Itential Platform servers — get, create, import, export, and copy 35+ resource types from the command line.

Quick Start

Install

Download the latest release for your platform from the releases page:

# Linux x64
curl -LO https://github.com/itential/ipctl/releases/latest/download/ipctl-linux-x86_64.tar.gz
tar -xzf ipctl-linux-x86_64.tar.gz
sudo mv ipctl /usr/local/bin/

git clone https://github.com/itential/ipctl.git && cd ipctl
make build
./bin/ipctl --version

Configure

Create ~/.platform.d/config.toml with a server profile:

["profile default"]
host = "platform.example.com"
port = 443
use_tls = true
username = "admin"
password = "your-password"

Use

Features

Configuration

ipctl loads configuration from ~/.platform.d/config by default. Supports INI, YAML, TOML, and JSON formats (auto-detected by file extension).

Profile Options

Authentication requires either username/password or client_id/client_secret.

Environment Variables

Override any profile value with IPCTL_PROFILE_<NAME>_<KEY>:

export IPCTL_PROFILE_PROD_PASSWORD=secret
ipctl get projects --profile prod

Precedence

CLI flags > environment variables > config file > defaults

See the Configuration Reference for complete details including multi-format examples.

Supported Resources

See the Command Quick Reference for the full matrix of supported operations per resource.

Usage Examples

ipctl get projects
ipctl describe project "My Project"
ipctl create project "New Project" --description "Project description"
ipctl delete project "Old Project"
ipctl export project "My Project" \
  --repository git@github.com:org/repo.git \
  --branch main

ipctl get automations
ipctl describe automation "Deploy Config" --output json
ipctl import automation \
  --repository https://github.com/org/automations.git \
  --reference v1.0.0
ipctl copy automation "Deploy Config" --from dev --to staging

ipctl get adapters
ipctl describe adapter "ServiceNow"
ipctl start adapter "ServiceNow"
ipctl stop adapter "ServiceNow"
ipctl restart adapter "ServiceNow"

Documentation

• Configuration Reference — profile options, formats, environment variables
• Command Quick Reference — operations matrix per resource
• API Command Reference — detailed API command docs
• Working with Repositories — Git-based import/export
• Logging Reference — log levels, JSON output, sensitive data redaction
• Running from Source — development setup

Contributing

Contributions are welcome. See CONTRIBUTING.md for development setup, branch conventions, and the pull request process.

All contributors must sign the Contributor License Agreement before contributions can be merged.

License

This project is licensed under the GNU General Public License v3.0.

Support

• GitHub Issues
• Itential Documentation