Skip to main content

Quickstart

New users? Use Option 1: Interactive Wizard for the fastest setup.

Advanced users? See Option 2: Manual Configuration for full control.

1. Create a configuration​

testbench-requirement-service init

This single command walks you through:

It creates a complete config.toml when finished.

2. Start the service​

testbench-requirement-service start

3. Open Swagger UI​

Visit http://127.0.0.1:8020/docs to explore the API interactively.

4. Quick API check​

curl -u "ADMIN_USERNAME:PASSWORD" http://127.0.0.1:8020/projects

That's it! Your service is ready to use.

Option 2: Manual Configuration​

1. Install optional dependencies (if needed)​

Choose the extras for your data source. See Installation for available options.

2. Create the configuration file​

Create a new file called config.toml in the root directory of your installation. Start from this minimal example for the JSONL reader:

# config.toml
[testbench-requirement-service]
reader_class = "JsonlRequirementReader"
host = "127.0.0.1"
port = 8020

[testbench-requirement-service.reader_config]
requirements_path = "requirements/jsonl/"

For other readers see JSONL, Excel, or Jira.

3. Set credentials​

The API uses HTTP Basic Auth. Generate a hashed password:

testbench-requirement-service set-credentials

This prompts for username and password and stores a secure hash in config.toml.

4. Start the service​

testbench-requirement-service start

5. Open Swagger UI​

Visit http://127.0.0.1:8020/docs.

6. Quick API check​

curl -u "ADMIN_USERNAME:PASSWORD" http://127.0.0.1:8020/projects
tip

Use testbench-requirement-service configure to update specific parts of your configuration later without starting from scratch.

API documentation endpoints​

Once the service is running, these endpoints are available without authentication:

EndpointDescription
/docsInteractive Swagger UI
/docs/openapi.jsonOpenAPI specification (JSON)
/openapi.yamlOpenAPI specification (YAML)

Next steps​