Knowledge · Guidelines · architecture

Vault Naming Convention

Naming convention for 1Password items in the sbx.workspace vault

Metadata

architecture architecture mandatory

Description

All 1Password items in the sbx.workspace vault follow a structured naming pattern that encodes project, service, and environment. This enables automated op:// reference generation by sbx project bootstrap and sbx vault inject, and ensures consistency across all projects.

Procedures

Showing 3 of 4

  1. 1 Use sbx project bootstrap --target env to generate .env.example
    The bootstrap command automatically produces op:// refs following this convention
  2. 2 Resolve to .env with sbx vault inject
    sbx vault inject reads .env.example, resolves op:// refs via 1Password CLI, writes .env (gitignored)
  3. 3 Never hardcode credentials in code or YAML
    All secrets flow through op:// references — Decision #0255