Vaktum CLI

Vaktum CLI Overview

The Vaktum CLI is a powerful command-line tool that allows you to run Vaktum's core functionality locally on your machine or in your CI/CD pipelines.

Key Features

The following functionality is supported from the CLI tooling:

1. API Validation: Validate OpenAPI specifications for correctness and best practices
2. SDK Generation: Generate client SDKs from your API definitions
3. Test Execution: Run API tests against your environments
4. Test Runner: Host a local test runner to execute tests against private APIs

No Cost to Use

The Vaktum CLI tooling is available at no cost. It is designed to be downloaded freely and used in local development and CI/CD pipelines.

Artifacts generated in Vaktum.com or via the Vaktum API are designed to work seamlessly with the CLI tooling. For example, test suites created on Vaktum.com are stored in open formats and can be executed with the CLI. This approach reduces the risk of vendor lock-in and gives you full control over your testing assets.

Installation

To obtain the Vaktum CLI:

1. Visit the Vaktum.com download page
2. Download the appropriate version for your operating system
3. Make the file executable (on Linux/macOS): chmod +x vaktum
4. Optionally, add to your PATH for easier access

Basic Usage

# Check the CLI version
./vaktum --version

# Get help
./vaktum --help

# Validate an API definition
./vaktum validate --api path/to/openapi.json

# Generate an SDK
./vaktum generate sdk --api path/to/openapi.json --language typescript --output ./sdk

# Run tests
./vaktum test --tests path/to/tests.json --env path/to/environment.json

# Start a local test runner
./vaktum runner start

CLI vs. Vaktum.com

While the CLI provides essential testing functionality, Vaktum.com offers additional features:

For more detailed information on specific CLI functions, see:

• Run Tests
• Test Runners
• Local Development
• CI/CD Integration