CLI Tool

The Piora CLI is the official command-line tool that lets you manage servers, applications, and deployments directly from the terminal.

Installation

Via npm

npm install -g @piora/cli

Via Homebrew (macOS)

brew install piora-dev/tap/piora

Verify Installation

piora --version
# piora/1.0.0 darwin-arm64

Initial Setup

Login

piora login

This opens your browser for OAuth authorization. Once authorized, the CLI automatically obtains and stores the token.

Login with API Token

For CI/CD environments, you can directly set the token:

piora login --token piora_token_xxxxxxxxxxxx

# Or use an environment variable
export PIORA_API_TOKEN=piora_token_xxxxxxxxxxxx

Common Commands

Server Management

# List all servers
piora servers list

# View server details
piora servers info <server-id>

# View server stats
piora servers stats <server-id>

Application Management

# List all applications
piora apps list

# View application details
piora apps info <app-id>

# Create a new application
piora apps create --name my-app --server <server-id>

# Delete an application
piora apps delete <app-id>

Deployment

# Trigger deployment
piora deploy <app-id>

# Trigger deployment (specific branch)
piora deploy <app-id> --branch main

# View deployment status
piora deploy status <app-id>

# View deployment logs
piora deploy logs <app-id>

# Rollback to previous version
piora deploy rollback <app-id>

Logs

# View application logs in real time
piora logs <app-id>

# Stream logs
piora logs <app-id> --follow

# View last 100 lines
piora logs <app-id> --lines 100

Environment Variables

# List environment variables
piora env list <app-id>

# Set an environment variable
piora env set <app-id> KEY=value

# Set multiple environment variables
piora env set <app-id> KEY1=value1 KEY2=value2

# Remove an environment variable
piora env unset <app-id> KEY

# Import from .env file
piora env import <app-id> .env

Environment Variable Effect

After modifying environment variables, you need to redeploy the application for changes to take effect. Use the --deploy flag to auto-trigger a deployment:

piora env set <app-id> KEY=value --deploy

CI/CD Integration

GitHub Actions

name: Deploy to Piora
on:
  push:
    branches: [main]

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Install Piora CLI
        run: npm install -g @piora/cli

      - name: Deploy
        run: piora deploy ${{ secrets.PIORA_APP_ID }}
        env:
          PIORA_API_TOKEN: ${{ secrets.PIORA_API_TOKEN }}

GitLab CI

deploy:
  stage: deploy
  image: node:20
  script:
    - npm install -g @piora/cli
    - piora deploy $PIORA_APP_ID
  variables:
    PIORA_API_TOKEN: $PIORA_API_TOKEN
  only:
    - main

Configuration File

CLI settings are stored in ~/.piora/config.json:

{
  "token": "piora_token_xxxxxxxxxxxx",
  "default_server": "server-id",
  "output": "table"
}

Output Formats

# Table format (default)
piora servers list --output table

# JSON format
piora servers list --output json

# Compact format
piora servers list --output compact

All Commands

# View all available commands
piora help

# View help for a specific command
piora help deploy
piora deploy --help