Skip to content

vens init

Who this is for: anyone who wants a valid config.yaml without writing one by hand. By the end of this page: you know what vens init asks, what it writes, and when it refuses to overwrite.

For a walkthrough, see Quickstart.


Synopsis

vens init [--output FILE] [--force]

Ask a short series of questions about the system being scored and write the answers as a config.yaml that vens generate accepts. Only the project name and the three required context fields are mandatory; every other question can be skipped with Enter.


What it asks

Question Required Values
Project name Yes Any non-empty string
Project description No Free text
Exposure Yes internal / private / internet
Data sensitivity Yes low / medium / high / critical
Business criticality Yes low / medium / high / critical
Availability requirement No low / medium / high / critical
Compliance requirements No Comma-separated list, e.g. GDPR, SOC2
Audit requirement No low / medium / high
Notes No Free text

An invalid answer is re-prompted instead of failing. The generated file is validated before it is written: vens init parses the final file (header included) and refuses to write a config vens generate would reject.


Flags

Flag Default Description
--output, -o config.yaml Path of the config file to write.
--force false Overwrite the output file if it already exists.

Existing files

An existing file is left alone unless --force is passed. The check happens twice: once before the first question, so nobody answers nine questions for a file that cannot be written, and again at write time — a file created while the user was answering is not silently replaced. A directory as the target, an empty --output, or a missing parent directory fails before any question is asked.

The generated file starts with a comment telling you how to use it:

# Generated by `vens init`. Edit any value, then pass this file to vens generate --config-file (see vens generate --help).

Edit any value in place — the file is a normal config.yaml. Security controls and value lists are not asked about here; they are added when the wizard is extended for the new config schema.


Example

$ vens init
Project name: my-api
Project description (optional, Enter to skip): Backend API
Exposure [internal/private/internet]: internet
Data sensitivity [low/medium/high/critical]: high
Business criticality [low/medium/high/critical]: critical
Availability requirement (optional) [low/medium/high/critical]: high
Compliance requirements, comma-separated (optional) [PCI-DSS, HIPAA, GDPR, SOX, ISO27001, FedRAMP, NIST, CCPA, SOC2, FISMA, ITAR, CMMC]: GDPR
Audit requirement (optional) [low/medium/high]: medium
Notes (optional, Enter to skip):
Wrote config.yaml