Skip to content

Latest commit

 

History

History
75 lines (52 loc) · 1.64 KB

settings.md

File metadata and controls

75 lines (52 loc) · 1.64 KB

settings command group

Manage non-sensitive configuration key-value pairs, including JSON arrays.

Table of Contents

settings set

Create or update a setting.

Syntax

byo settings set --key <key> --value <value>

Options

Option Required Description
--key Yes Setting key name
--value Yes Setting value

Examples

byo settings set --key Demo:ApiBaseUrl --value https://api.example.com
byo settings set --key ProjectName --value MyApplication
byo settings set --key Environment --value "dev|staging|prod"
byo settings set --key Jira:Priorities --value ["High","Medium","Low"]
byo settings set --key Teams:Channels --value ["general","engineering","alerts"]

Behavior

  • Prompts before replacing an existing key
  • In an interactive session, omitting --key lets you pick an existing setting and omitting --value prompts for the new value
  • Stores values in local configuration
  • If --value is a valid JSON array, it is saved as a real JSON array in settings.json
  • In PowerShell, prefer single quotes around JSON values to avoid escaping double quotes

settings list

List settings.

Syntax

byo settings list

settings delete

Delete a setting.

Syntax

byo settings delete --key <key>

Behavior

  • Deletes the exact key provided by --key