CLI Reference

Installation

From Release Binary

# Linux/macOS
chmod +x apiark-cli-*
sudo mv apiark-cli-* /usr/local/bin/apiark

From Source

cd apps/cli
cargo build --release
# Binary at: target/release/apiark

Commands

apiark run

# Run entire collection
apiark run ./my-collection
# Run a specific folder
apiark run ./my-collection/users
# Run a single request
apiark run ./my-collection/users/get-all-users.yaml
# With environment
apiark run ./my-collection --env production
# With data file (data-driven testing)
apiark run ./my-collection --data test-data.csv
# Multiple iterations
apiark run ./my-collection --iterations 5
# Delay between requests (ms)
apiark run ./my-collection --delay 500
# Stop on first failure
apiark run ./my-collection --bail

Reporter Options

# JSON output (default)
apiark run ./my-collection --reporter json
# JUnit XML (for CI/CD)
apiark run ./my-collection --reporter junit --output results.xml
# HTML report
apiark run ./my-collection --reporter html --output report.html
# Write to file
apiark run ./my-collection --reporter json --output results.json

apiark import

# Auto-detect format
apiark import collection.json
# Specify format explicitly
apiark import collection.json --format postman
apiark import workspace.json --format insomnia
apiark import api-spec.yaml --format openapi
apiark import collection.bru --format bruno
apiark import requests.har --format har
apiark import collection.json --format hoppscotch
# Specify output directory
apiark import collection.json --output ./my-project
# Import from cURL
apiark import --curl 'curl -X GET https://api.example.com/users -H "Authorization: Bearer token"'

apiark export

# Export to Postman format
apiark export ./my-collection --format postman --output postman-collection.json
# Export to OpenAPI
apiark export ./my-collection --format openapi --output api-spec.yaml
# Export to cURL (all requests)
apiark export ./my-collection --format curl

apiark lint

apiark lint ./my-collection
# Checks for: missing URLs, invalid YAML, unused variables, etc.

apiark mock

# Start on default port (4000)
apiark mock ./my-collection
# Custom port
apiark mock ./my-collection --port 8080
# With CORS disabled
apiark mock ./my-collection --no-cors

Exit Codes

CI/CD Integration

GitHub Actions

name: API Tests
on: [push, pull_request]
jobs:
 test:
 runs-on: ubuntu-latest
 steps:
 - uses: actions/checkout@v4
 - name: Download ApiArk CLI
 run: |
 curl -L -o apiark https://github.com/berbicanes/apiark/releases/latest/download/apiark-cli-linux-x86_64
 chmod +x apiark

 - name: Run API tests
 run: ./apiark run ./tests/api-collection --env ci --reporter junit --output results.xml
 - name: Upload test results
 if: always()
 uses: actions/upload-artifact@v4
 with:
 name: api-test-results
 path: results.xml

GitLab CI

api-tests:
 stage: test
 script:
 - curl -L -o apiark https://github.com/berbicanes/apiark/releases/latest/download/apiark-cli-linux-x86_64
 - chmod +x apiark
 - ./apiark run ./tests/api-collection --env ci --reporter junit --output results.xml
 artifacts:
 reports:
 junit: results.xml

Jenkins

pipeline {
 agent any
 stages {
 stage('API Tests') {
 steps {
 sh 'curl -L -o apiark https://github.com/berbicanes/apiark/releases/latest/download/apiark-cli-linux-x86_64'
 sh 'chmod +x apiark'
 sh './apiark run ./tests/api-collection --env ci --reporter junit --output results.xml'
 }
 post {
 always {
 junit 'results.xml'
 }
 }
 }
 }
}

Environment Variables

# Set environment via env var
APIARK_ENV=production apiark run ./my-collection
# Verbose output
APIARK_LOG=debug apiark run ./my-collection
# Custom timeout (ms)
APIARK_TIMEOUT=30000 apiark run ./my-collection

Tips