appveyor-cli

AppVeyor CLI

CLI for the AppVeyor CI/CD API — built for humans and AI agents.

Projects, builds, environments, deployments, and team management. Rich terminal output. Structured JSON. 8 agent skills included.

Table of Contents

• Features
• Installation
• Configuration
• Usage
• AI Plugin
• Building from Source
• Technology
• API Coverage
• License
• Contributing
• Documentation Map
• References

Features

• 📦 Project Management - List, inspect, add, and delete AppVeyor projects
• 🔨 Build Management - Start, cancel, re-run builds and view build history with logs
• 🌍 Environment Management - List, inspect, add, and delete deployment environments
• 🚀 Deployment Management - Start, inspect, and cancel deployments
• 👥 Team Management - Manage users, collaborators, and roles with permissions
• 🎨 Rich Terminal Output - Spectre.Console tables, panels, and color-coded statuses
• 🤖 JSON Output - --json flag on every command for scripting and AI agent consumption
• 🔒 Read-Only Mode - --read-only flag or APPVEYOR_READ_ONLY=true to prevent accidental writes
• 🔐 Flexible Authentication - Environment variables, config file, or interactive setup
• 💻 Cross-Platform - Pre-built binaries for Linux, macOS (Intel + ARM), and Windows

Installation

Quick Install

Linux/macOS:

curl -sSL https://raw.githubusercontent.com/jrgcubano/appveyor-cli/main/install.sh | bash

Windows (PowerShell):

iwr -useb https://raw.githubusercontent.com/jrgcubano/appveyor-cli/main/install.ps1 | iex

Pre-built Binaries

Download the latest release for your platform from the Releases page.

From Source

git clone https://github.com/jrgcubano/appveyor-cli.git
cd appveyor-cli
dotnet run --project src/AppVeyorCli -- --help

Uninstall

curl -sSL https://raw.githubusercontent.com/jrgcubano/appveyor-cli/main/install.sh | bash -s -- --uninstall

Configuration

Initial Setup

# Interactive configuration
appveyor config set

# Or provide values directly
appveyor config set --token v2.your-api-token --account your-account-name

# Test the connection
appveyor config test

Environment Variables

Environment variables take precedence over the config file:

Variable	Description
APPVEYOR_API_TOKEN	API token (required)
APPVEYOR_ACCOUNT_NAME	Account name (for v2 tokens with multi-account access)
APPVEYOR_API_URL	API base URL (default: https://ci.appveyor.com)
APPVEYOR_OUTPUT	Set to json to default all output to JSON
APPVEYOR_READ_ONLY	Set to true to block all write operations

Config File

Stored at ~/.appveyor/config.json:

{
  "token": "v2.your-api-token",
  "accountName": "your-account",
  "apiUrl": "https://ci.appveyor.com"
}

Usage

Projects

# List all projects
appveyor project list

# Get project details with last build info
appveyor project get myaccount/myproject

# Add a new project from GitHub
appveyor project add --repo-provider gitHub --repo-name owner/repo

# View project settings
appveyor project settings myaccount/myproject
appveyor project settings myaccount/myproject --yaml

# Delete a project
appveyor project delete myaccount/myproject

Builds

# Start a build
appveyor build start myaccount/myproject --branch main

# Start a build for a specific commit
appveyor build start myaccount/myproject --branch main --commit abc123

# View build history
appveyor build history myaccount/myproject --count 10
appveyor build history myaccount/myproject --branch main

# Cancel a running build
appveyor build cancel myaccount/myproject 1.0.42

# Re-run a build
appveyor build rerun 12345
appveyor build rerun 12345 --incomplete-only

# Download build job log
appveyor build log job-id-here

Environments

# List all deployment environments
appveyor environment list

# Get environment details
appveyor environment get 123

# Add an environment
appveyor environment add --name Production --provider Agent