PipeOps CLI Documentation¶

Welcome to the official documentation for PipeOps CLI — a fast, cross-platform command-line tool for authenticating with PipeOps, managing projects, provisioning servers, deploying pipelines, and working with agents for Kubernetes cluster management.

What is PipeOps CLI?¶

PipeOps CLI provides a unified interface to:

Authenticate securely (OAuth with PKCE)
Create, list, and manage PipeOps projects
Provision and manage servers and environments
Create, manage, and deploy CI/CD pipelines
Install and manage PipeOps agents
Monitor status with rich terminal output or JSON

Key Features¶

Beautiful terminal UX with colors, spinners, and progress indicators
Comprehensive command set for projects, servers, pipelines, and agents
Docker-friendly: run the CLI in containers
CI/CD ready: deterministic commands for automation
Extensive documentation with examples and references

Getting StartedCommandsAdvanced

Installation — Install PipeOps CLI on your system
Quick Start — Get up and running in minutes
Configuration — Configure your CLI environment

Overview — Complete command reference
Authentication — Login, logout, and auth status
Projects — Create, list, and manage projects
Deploy — Pipelines and deployment workflows
Servers — Provisioning and server operations
Agents — Install and manage PipeOps agents

Docker Usage — Running CLI in containers
CI/CD Integration — Automation workflows
Troubleshooting — Common issues and solutions

Quick Start¶

Get started with PipeOps CLI in a few steps:

Install the CLI (macOS/Linux):
```
 curl -fsSL https://get.pipeops.dev/cli.sh | bash
```
For Windows and alternative methods, see the Installation guide.
Log in:
```
pipeops auth login
```
Check authentication status:
```
pipeops auth status
```
List projects:
```
pipeops project list
```

Get help:

pipeops --help
pipeops auth --help
pipeops project --help

What's New¶

Latest Features¶

Secure OAuth login with PKCE for device-friendly authentication
Project lifecycle commands: create, list, configure, deploy
Agent management for Kubernetes cluster integration
Agent installation and management across major platforms
JSON output mode for scripting and automation

Recent Updates¶

Improved error messages and diagnostics
Enhanced Windows and macOS support
Better Docker ergonomics and examples
Expanded command help and documentation

Platform Support¶

Platform	Architecture	Status
Linux	x86_64	Supported
Linux	ARM64	Supported
Linux	ARM	Supported
macOS	x86_64	Supported
macOS	ARM64	Supported
Windows	x86_64	Supported
FreeBSD	x86_64	Supported

Community & Support¶

Documentation: Comprehensive guides and references
Issues: https://github.com/PipeOpsHQ/pipeops-cli/issues
Discussions: https://github.com/PipeOpsHQ/pipeops-cli/discussions
Discord: https://discord.gg/pipeops
Email: support@pipeops.io

License¶

This project is licensed under the MIT License.

Made with love by the PipeOps team