Quick Start¶

Get up and running with PipeOps CLI in just a few minutes. This guide will walk you through the essential steps to start using PipeOps CLI effectively.

Prerequisites¶

Before you begin, make sure you have:

PipeOps CLI installed (see Installation)
A PipeOps account (sign up at pipeops.io)
Basic familiarity with command-line interfaces

Step 1: Verify Installation¶

First, let's make sure PipeOps CLI is properly installed:

# Check version
pipeops --version

# View available commands
pipeops --help

You should see output similar to:

 PipeOps CLI Version: 1.0.0

Usage:
  pipeops [command]

Available Commands:
  agent        Manage agent-related commands and tasks
  auth         Authentication and user management
  deploy       Deploy applications and pipelines
  project      Project management
  server       Server management
  k3s          K3s cluster management
  help        Help about any command

Step 2: Authentication¶

Authenticate with your PipeOps account:

pipeops auth login

This will:

Open your default web browser
Redirect you to the PipeOps authentication page
Complete the OAuth flow
Save your credentials locally

Authentication Methods

PipeOps CLI supports multiple authentication methods: - OAuth (Recommended): Secure browser-based authentication - Service Account Token: For CI/CD and automation - Environment Variables: For containerized environments

Verify Authentication¶

Check your authentication status:

pipeops auth status

You should see your user information and authentication status.

Step 3: Project Management¶

List your existing projects:

pipeops project list

If you don't have any projects yet, you can create one:

pipeops project create my-first-project

Step 4: Deployment¶

Let's deploy a simple application to see PipeOps CLI in action:

# Create a new deployment
pipeops deploy create --name hello-world --image nginx:latest

# Check deployment status
pipeops deploy status hello-world

# View deployment logs
pipeops deploy logs hello-world

Step 5: Agent Management¶

If you want to manage Kubernetes clusters, install a PipeOps agent:

# Install agent with automatic cluster detection
pipeops agent install your-token-here

# Or install on existing cluster
pipeops agent install --existing-cluster --cluster-name="my-cluster"

Step 6: Monitoring¶

Use these commands to monitor and manage your resources:

# Check server status
pipeops server list

# View project logs
pipeops project logs my-first-project

# Get system status
pipeops status

Common Workflows¶

Daily Operations¶

# Morning routine - check status
pipeops auth status
pipeops project list
pipeops server list

# Deploy updates
pipeops deploy update my-app --image my-app:v2.0

# Monitor deployments
pipeops deploy logs my-app --follow

Development Workflow¶

# Create new project
pipeops project create my-dev-project

# Deploy development environment
pipeops deploy create --name dev-env --image my-app:dev

# Test locally
pipeops proxy start --port 8080

# Clean up
pipeops deploy delete dev-env

CI/CD Integration¶

# Authenticate with service account
export PIPEOPS_TOKEN="your-service-account-token"

# Deploy from CI/CD
pipeops deploy create --name production --image my-app:$BUILD_NUMBER

# Verify deployment
pipeops deploy status production

Configuration¶

Environment Variables¶

Set up environment variables for automation:

# Add to your shell profile (~/.bashrc, ~/.zshrc, etc.)
export PIPEOPS_API_URL="https://api.pipeops.io"
export PIPEOPS_LOG_LEVEL="info"
export PIPEOPS_CONFIG_PATH="$HOME/.pipeops.json"

Configuration File¶

PipeOps CLI stores configuration in ~/.pipeops.json:

{
  "version": {
    "version": "1.0.0"
  },
  "updates": {
    "last_update_check": "2024-01-01T00:00:00Z",
    "skip_update_check": false
  },
  "service_account_token": "your-token-here"
}

Next Steps¶

Now that you're up and running, explore these areas:

Commands Overview: Complete command reference
Project Management: Advanced project operations
Deployment Guide: Complex deployment scenarios
Agent Management: Kubernetes cluster management
Docker Usage: Containerized workflows
CI/CD Integration: Automation and pipelines

Getting Help¶

If you run into issues:

Check command help: pipeops <command> --help
View logs: pipeops logs <resource>
Check status: pipeops status
Review troubleshooting guide
Join our Discord community

Maintenance and Updates¶

Keeping PipeOps CLI Updated¶

Regular updates ensure you have the latest features and security improvements:

# Check for updates
pipeops update check

# Update to latest version
pipeops update

# View current version
pipeops --version

Update Notifications¶

PipeOps CLI will notify you when updates are available:

 A new version of PipeOps CLI is available!
   Current: v1.0.0
   Latest:  v1.1.0

   Run 'pipeops update' to upgrade

Automatic Updates¶

Enable automatic updates for seamless maintenance:

# Enable automatic updates
pipeops config set auto_update true

# Set update channel (stable, beta, alpha)
pipeops config set update_channel stable

Backup and Migration¶

Export Configuration¶

Before major updates, backup your configuration:

# Export current configuration
pipeops config export > pipeops-config-backup.json

# Backup authentication
cp ~/.pipeops.json ~/pipeops-backup.json

Import Configuration¶

Restore configuration on a new machine:

# Import configuration
pipeops config import pipeops-config-backup.json

# Or manually copy
cp ~/pipeops-backup.json ~/.pipeops.json

Uninstalling¶

If you need to remove PipeOps CLI:

Quick Uninstall¶

# Using package manager (Homebrew)
brew uninstall pipeops

# Manual removal (Linux/macOS)
sudo rm -f /usr/local/bin/pipeops
rm -f ~/.pipeops.json

# Windows (PowerShell)
Remove-Item "$env:USERPROFILE\bin\pipeops.exe" -Force
Remove-Item "$env:USERPROFILE\.pipeops.json" -Force

Complete Cleanup¶

For complete removal including all data:

# Remove all configuration and cache
rm -rf ~/.pipeops*
rm -rf ~/.cache/pipeops/
rm -rf ~/.local/share/pipeops/

# Verify removal
which pipeops  # Should return "not found"

Before Uninstalling¶

Consider these steps before removing PipeOps CLI:

Export configurations: pipeops config export
Document active deployments: pipeops deploy list
Note connected servers: pipeops server list
Backup project settings: pipeops project list --json

For detailed uninstall instructions, see the Installation Guide.

Congratulations!¶

You've successfully set up PipeOps CLI and completed your first operations. You're now ready to:

Manage projects and deployments
Monitor your infrastructure
Set up automated workflows
Scale your applications
Keep your CLI updated and maintained

Happy deploying!