Reference
This page documents exact behavior. Open the reference overview
add¶
Reference
add changes the shared project contract.
Use it when the application now requires a new variable as part of the repository-owned environment model.
Philosophy¶
add changes the shared model.
Use it when the project itself now requires a new variable, not when you only want to tweak your own local value.
What it does¶
- updates the contract
- stores the value in the active profile
- may infer metadata for the contract entry
- does not initialize other profiles implicitly
Useful options¶
--typeto set variable type explicitly--formatto set semantic string format such asjson,url, orcsvwhen--type string--required/--optional--sensitive/--non-sensitive--description--default--example--pattern--choice
When to use it¶
Use add when the variable becomes part of the shared project contract.
When not to use it¶
Do not use add when the contract already exists and you only want to change your local value. In that case, use set.
Related pages¶
remove¶
Use the inverse shared-model mutation when a variable should stop existing.