CLI Reference

Run collections, import/export, and integrate with CI/CD.

npm install -g @apiark/cli

apiark run

Run all requests in a collection or folder sequentially.

apiark run <collection-path>

--env <name>Use a specific environment

--data <file>Data-driven testing with CSV, JSON, or YAML file

--reporter <type>Output format: json, junit, html (default: json)

--delay <ms>Delay between requests in milliseconds

--iterations <n>Number of times to run the collection

--bailStop on first failure

$ apiark run ./my-api --env production --reporter junit
$ apiark run ./my-api/users --data users.csv --iterations 3

Import a collection from another tool.

apiark import <file>

--format <type>Source format: postman, insomnia, openapi, bruno, har, curl

--output <dir>Output directory (default: current directory)

$ apiark import postman-collection.json --format postman
$ apiark import openapi.yaml --format openapi --output ./my-api

Export a collection to another format.

apiark export <collection-path>

--format <type>Target format: postman, openapi

--output <file>Output file path

$ apiark export ./my-api --format postman --output my-api.postman.json
$ apiark export ./my-api --format openapi --output openapi.yaml

Validate collection YAML files for errors and warnings.

apiark lint <collection-path>

$ apiark lint ./my-api

Start a local mock server based on collection examples.

apiark mock <collection-path>

--port <number>Port to listen on (default: 4000)

$ apiark mock ./my-api --port 8080

0All tests passed

1One or more tests failed

2Collection or file not found

3Invalid configuration

4Network error