PipeOps CLI Overview
The PipeOps Command Line Interface (CLI) is a powerful tool that enables you to manage your entire PipeOps infrastructure directly from your terminal. Whether you're deploying applications, managing servers, or automating workflows, the CLI provides a fast and efficient way to interact with the PipeOps platform.
Why Use the PipeOps CLI?
- Speed and Efficiency: Execute commands faster than navigating through the web interface
- Automation: Integrate PipeOps operations into your CI/CD pipelines and scripts
- Developer-Friendly: Designed for developers who prefer command-line workflows
- Cross-Platform: Native support for Linux, macOS, Windows, and FreeBSD
- Secure: OAuth authentication with PKCE for device-friendly login
- Rich Output: Real-time status updates, formatted output, and JSON mode for scripting
Key Features
Authentication & Security
- Secure OAuth authentication with PKCE flow
- Token-based session management
- Multi-account support
Project Management
- Create and manage projects
- View project logs and status
- Configure project settings
Deployment Operations
- Deploy applications with a single command
- Deploy addons (databases, caching services, etc.)
- Manage local directory deployments
- Monitor deployments in real-time
- View deployment logs and status
Server Management
- List and manage servers
- Provision new server environments
- Configure server settings
Agent Management
- Install PipeOps agents on your infrastructure
- Set up and manage Kubernetes clusters
- Join worker nodes to clusters
- View cluster information
Developer Experience
- Real-time progress indicators
- Colored and formatted output
- JSON output mode for scripting
- Comprehensive help system
- Auto-update functionality
Command Categories
The PipeOps CLI organizes commands into logical categories:
- Authentication (
pipeops auth) - Login, logout, and account management - Projects (
pipeops project) - Project lifecycle management - Monitoring (
pipeops list,pipeops status,pipeops logs) - View project and addon information - Servers (
pipeops server) - Server provisioning and management - Agents (
pipeops agent) - Agent installation and cluster management - Utilities - Status checks, version info, updates, and proxy management
Getting Started
To get started with the PipeOps CLI:
- Install the CLI - Quick installation on any platform
- Quick Start Guide - Deploy your first project using the CLI
- Configuration - Configure the CLI for your environment
Next Steps
- New to PipeOps? Start with the Quick Start Guide
- Need Command Reference? Check the Commands Overview
- Advanced Usage? Explore Docker Integration and CI/CD Integration
- Having Issues? Visit the Troubleshooting Guide
CLI vs Web UI
The PipeOps CLI and Web UI provide complementary ways to interact with the platform:
| Feature | CLI | Web UI |
|---|---|---|
| Speed | Fast command execution | Visual navigation |
| Automation | Scriptable, CI/CD ready | Manual workflows |
| Learning Curve | Command syntax | Visual interface |
| Use Cases | Development, automation, scripting | Monitoring, exploration, configuration |
Many users find it beneficial to use both: the Web UI for exploration and monitoring, and the CLI for day-to-day development and automation tasks.
Support and Community
- Documentation: You're here! Explore the CLI section for comprehensive guides
- GitHub: pipeops-dev on GitHub
- Community: Join our Slack Community
- Support: Visit PipeOps Support
Ready to dive in? Head to the Installation Guide to get started!