Skip to content

setting.md

Latest commit

 

History

History
70 lines (47 loc) · 1.43 KB

setting.md

File metadata and controls

70 lines (47 loc) · 1.43 KB
Raw

Setting Commands

Use tapd setting commands to query TAPD workspace settings.

All setting commands use the configured TAPD credentials from tapd login or the TAPD_ACCESS_TOKEN / TAPD_CLIENT_ID / TAPD_CLIENT_SECRET environment variables.

Setting commands require a workspace:

tapd setting workspace --workspace-id 123456

The short form is also supported:

tapd setting workspace -w 123456

Output Formats

Setting commands default to table output:

tapd setting workspace -w 123456

Use JSON when piping to another program or when you need the full SDK response shape:

tapd setting workspace -w 123456 --format json

Workspace Settings

Show workspace settings:

tapd setting workspace -w 123456

Query one setting by name:

tapd setting workspace -w 123456 --type is_enabled_story_category
tapd setting workspace -w 123456 --type workspace_metrology

Known setting names exposed by the SDK are:

  • is_enabled_story_category
  • workspace_metrology

Developer Notes

The setting command implementation currently lives in:

internal/cmd/setting.go

When adding or renaming setting commands:

  1. Reuse the typed SDK methods from github.com/go-tapd/tapd.
  2. Keep table output compact and use --format json for full response data.
  3. Update features.md.
  4. Update this document.
  5. Regenerate shell completion files if they have been installed locally.