pipeops-cli

PipeOps CLI

PipeOps CLI is a powerful, cross-platform command-line tool that streamlines cloud-native development and deployment workflows. Securely authenticate with OAuth, manage projects and servers, deploy CI/CD pipelines, and monitor infrastructure—all from your terminal with a developer-friendly interface.

Why PipeOps CLI?

• Unified Workflow: Manage your entire development lifecycle from a single CLI
• Developer-First: Designed for productivity with intuitive commands and rich output
• Secure by Default: OAuth PKCE authentication with secure credential management
• Platform Agnostic: Works consistently across Linux, macOS, Windows, and FreeBSD
• CI/CD Ready: Perfect for automation scripts and continuous integration pipelines
• Real-time Feedback: Live status updates and progress indicators for long-running operations

Table of Contents

• PipeOps CLI
  • Why PipeOps CLI?
  • Table of Contents
  • Quick Install
    • macOS & Linux (recommended)
    • Windows (PowerShell)
    • Package managers
      • Homebrew (macOS/Linux)
      • Docker
      • Go install
  • Features
  • Quick Start
  • Commands Overview
    • Global Flags
  • Configuration
    • Environment Variables
  • Development
    • Prerequisites
    • Setup
    • Make targets
    • Project structure
  • Docker Usage
    • Run CLI in Docker
    • Docker Compose
  • Platforms
  • Contributing
    • Guidelines
  • Documentation
  • Support & Community
  • Release Process
  • License

Quick Install

macOS & Linux (recommended)

curl -fsSL https://raw.githubusercontent.com/PipeOpsHQ/pipeops-cli/main/install.sh | sh

Windows (PowerShell)

irm https://raw.githubusercontent.com/PipeOpsHQ/pipeops-cli/main/install.ps1 | iex

Package managers

Homebrew (macOS/Linux)

brew tap pipeops/pipeops
brew install pipeops

Docker

docker run --rm -it ghcr.io/pipeopshq/pipeops-cli:latest --help

Go install

go install github.com/PipeOpsHQ/pipeops-cli@latest

For more options and troubleshooting, see our Installation Guide

Features

• Secure Authentication: OAuth with PKCE for secure, device-friendly login
• Project Management: Complete lifecycle management - create, list, configure, and deploy projects
• Server Operations: Server provisioning and environment management
• CI/CD Integration: Pipeline management and deployment automation
• Agent Management: Install and manage PipeOps agents across platforms
• Cross-Platform: Native support for Linux, macOS, Windows, and FreeBSD
• Developer Experience: Real-time status updates, rich output formatting, and JSON mode
• Terminal UX: Clean interface with progress indicators and color-coded output

Quick Start

1. Log in to your PipeOps account

   pipeops auth login
   

2. Verify authentication status

   pipeops auth status
   

3. List your projects

   pipeops project list
   

4. Get help for any command

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

Commands Overview

Global Flags

• --help, -h: Show help information
• --version, -v: Display version information
• --json: Output results in JSON format
• --quiet, -q: Reduce non-essential output

Configuration

Configuration is stored at ~/.pipeops.json and includes:

• Authentication tokens: Secure OAuth credentials
• User preferences: Default settings and customizations
• API settings: Endpoint configurations

Environment Variables

Supported log levels: debug, info, warn, error

Development

Prerequisites

• Go 1.23+
• Git

Setup

# Clone
git clone https://github.com/PipeOpsHQ/pipeops-cli.git
cd pipeops-cli

# Dependencies
go mod download

# Build
make build

# Test
make test

# Lint
make lint

Make targets

make build          # Build the binary
make test           # Run tests
make lint           # Run linter
make clean          # Clean build artifacts
make install        # Install locally
make release        # Create release build
make docker-build   # Build Docker image
make docker-run     # Run in Docker

Project structure

pipeops-cli/
├── cmd/                 # CLI commands
│   ├── auth/           # Authentication commands
│   ├── project/        # Project management commands
│   ├── deploy/         # Deployment commands
│   └── ...
├── internal/           # Internal packages
│   ├── auth/           # Authentication logic
│   ├── client/         # HTTP client
│   ├── config/         # Configuration management
│   └── ...
├── models/             # Data models
├── utils/              # Utility functions
├── .goreleaser.yml     # Release configuration
├── Dockerfile          # Docker image
└── install.sh          # Installation script

Docker Usage

Run CLI in Docker

# Basic usage
docker run --rm -it ghcr.io/pipeopshq/pipeops-cli:latest --help

# With authentication (mount config)
docker run --rm -it \
  -v ~/.pipeops.json:/root/.pipeops.json \
  ghcr.io/pipeopshq/pipeops-cli:latest auth status

# Interactive shell
docker run --rm -it \
  -v ~/.pipeops.json:/root/.pipeops.json \
  --entrypoint /bin/sh \
  ghcr.io/pipeopshq/pipeops-cli:latest

Docker Compose

version: "3.8"
services:
  pipeops-cli:
    image: ghcr.io/pipeopshq/pipeops-cli:latest
    volumes:
      - ~/.pipeops.json:/root/.pipeops.json
    command: ["project", "list"]

Platforms

Contributing

We welcome contributions!

1. Fork the repository and create a feature branch
2. Follow coding standards and add tests
3. Validate with make test and make lint
4. Open a PR with a clear description

Guidelines

• Code Quality: Follow Go best practices and conventions
• Documentation: Write clear, comprehensive documentation
• Testing: Include tests for new functionality
• Compatibility: Ensure changes work across supported platforms
• Collaboration: Be respectful and constructive in discussions

See CONTRIBUTING.md for detailed guidelines.

Documentation

• Installation Guide - Complete installation instructions
• Quick Start Guide - Get up and running quickly
• Commands Reference - Detailed command documentation
• API Reference - Complete API documentation
• CLI User Guide - In-depth CLI usage guide

Support & Community

• Documentation - Complete guides and references
• GitHub Issues - Bug reports and feature requests
• GitHub Discussions - Community discussions
• Discord - Real-time community chat
• Email Support - Direct technical support
• Twitter - Latest news and updates

Release Process

Releases are automated via GitHub Actions when tags are pushed:

1. Create a release tag

   git tag -a v1.0.0 -m "Release v1.0.0"
   

2. Push the tag

   git push origin v1.0.0
   

3. Automated CI process

   • Build binaries for all supported platforms
   • Create GitHub release with artifacts and changelog
   • Push Docker images to registry
   • Update package managers (Homebrew, etc.)

License

This project is licensed under the MIT License. See LICENSE for details.

Made with love by the PipeOps team