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.
- 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
- PipeOps CLI
curl -fsSL https://raw.githubusercontent.com/PipeOpsHQ/pipeops-cli/main/install.sh | sh
irm https://raw.githubusercontent.com/PipeOpsHQ/pipeops-cli/main/install.ps1 | iex
brew tap pipeops/pipeops
brew install pipeops
docker run --rm -it ghcr.io/pipeopshq/pipeops-cli:latest --help
go install github.com/PipeOpsHQ/pipeops-cli@latest
📋 For more options and troubleshooting, see our Installation Guide
- 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
-
Log in to your PipeOps account
pipeops auth login -
Verify authentication status
pipeops auth status -
List your projects
pipeops project list -
Get help for any command
pipeops --help pipeops auth --help pipeops project --help
| Command | Description | Examples |
|---|---|---|
pipeops auth |
Manage authentication and user details | pipeops auth login, pipeops auth status |
pipeops project |
Manage, list, and deploy projects | pipeops project list, pipeops project create |
pipeops deploy |
Manage and deploy CI/CD pipelines | pipeops deploy pipeline, pipeops deploy status |
pipeops server |
Manage server-related operations | pipeops server list |
pipeops agent |
Install and manage PipeOps agents | pipeops agent install, pipeops agent status |
--help, -h: Show help information--version, -v: Display version information--json: Output results in JSON format--quiet, -q: Reduce non-essential output
Configuration is stored at ~/.pipeops.json and includes:
- Authentication tokens: Secure OAuth credentials
- User preferences: Default settings and customizations
- API settings: Endpoint configurations
| Variable | Description | Default |
|---|---|---|
PIPEOPS_CONFIG_PATH |
Custom config file location | ~/.pipeops.json |
PIPEOPS_API_URL |
Override API endpoint | Default API URL |
PIPEOPS_LOG_LEVEL |
Set logging level | info |
Supported log levels: debug, info, warn, error
- Go 1.23+
- Git
# 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 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
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
# 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
version: "3.8"
services:
pipeops-cli:
image: ghcr.io/pipeopshq/pipeops-cli:latest
volumes:
- ~/.pipeops.json:/root/.pipeops.json
command: ["project", "list"]
| Platform | Architecture | Status |
|---|---|---|
| Linux | x86_64 | ✅ |
| Linux | ARM64 | ✅ |
| Linux | ARM | ✅ |
| macOS | x86_64 (Intel) | ✅ |
| macOS | ARM64 (M1/M2) | ✅ |
| Windows | x86_64 | ✅ |
| FreeBSD | x86_64 | ✅ |
We welcome contributions!
- Fork the repository and create a feature branch
- Follow coding standards and add tests
- Validate with
make testandmake lint - Open a PR with a clear description
- 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.
- 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
- 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
Releases are automated via GitHub Actions when tags are pushed:
-
Create a release tag
git tag -a v1.0.0 -m "Release v1.0.0" -
Push the tag
git push origin v1.0.0 -
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.)
This project is licensed under the MIT License. See LICENSE for details.
Made with ❤️ by the PipeOps team