Managing the manifest

Topaz offers three commands to manage the manifest:

• topaz directory get manifest
• topaz directory set manifest
• topaz directory delete manifest

Getting the manifest

topaz directory get manifest retrieves the current manifest and prints it to stdout.

Example:

topaz directory get manifest -i
>>> get manifest to
# yaml-language-server: $schema=https://www.topaz.sh/schema/manifest.json
---

### filename: manifest.yaml ###
### datetime: 2023-10-17T00:00:00-00:00 ###
### description: citadel manifest ###

### model ###
model:
  version: 3

### object type definitions ###
types:
  ### display_name: User ###
  user:
    relations:
      ### display_name: user#manager ###
      manager: user

  ### display_name: Identity ###
  identity:
    relations:
      ### display_name: identity#identifier ###
      identifier: user

  ### display_name: Group ###
  group:
    relations:
      ### display_name: group#member ###
      member: user

Setting a manifest

topaz directory set manifest set the manifest from stdin. You can also specify a filename as an argument.

Example:

topaz directory set manifest -i ./manifest.yaml
>>> set manifest from /Users/ogazitt/.local/share/topaz/tmpl/todo/model/manifest.yaml

Deleting the manifest

topaz directory delete manifest removes the manifest and deletes all data. After deleting a manifest, you must set a new manifest before you can use the Topaz directory.

note

topaz directory load and topaz directory save have been deprecated in favor of topaz directory set manifest and topaz directory get manifest, respectively.