Introduction
Quickstart
Get started with the Vaktum platform
Quick Start
Vaktum can be used both locally through the command line interface (CLI), online through Vaktum.com or using the Vaktum API
The following features are available on the different versions of Vaktum
| Feature | Vaktum CLI | Vaktum.com | Vaktum API |
|---|---|---|---|
| Scrape API Docs | ❌ | ✅ | ✅ |
| Validate API | ✅ | ✅ | ✅ |
| Edit API | ❌ | ✅ | ✅ |
| Generate Tests | ❌ | ✅ | ✅ |
| Edit test | ❌ | ✅ | ❌ |
| Generate Data Model | ❌ | ✅ | ✅ |
| Generate SDK | ✅ | ✅ | ✅ |
| Run Tests | ✅ | ✅ | ✅ |
Setting up Vaktum CLI
The Vaktum binaries are not yet published online. To get a copy of the binaries, send an email to hello@vaktum.com
One the binaries have been obtained they can be executed like any CLI tool from the command prompt. For example
./vaktum --version
./vaktum validate <openapi.json>
Accessing Vaktum.com
Vakum.com is accessible to anyone to sign up. Visit: https://app.vaktum.com/signup to register an account.
Supported log in methods:
- Username & Password
- Sign-in with Google
- Sign-in with GitHub
