Metaplay Docs

Appearance

metaplay secrets update ENVIRONMENT NAME [flags]

Update a user secret in the target environment

metaplay secrets update ENVIRONMENT NAME [flags] ​

Update an existing user secret in the target environment. This command allows you to add new entries, update existing entries, or remove entries from a secret.

Use the --from-literal and --from-file flags to add or update key-value pairs. Use the --remove flag to remove entries by key.

At least one of --from-literal, --from-file, or --remove must be specified.

Expected arguments:

  • ENVIRONMENT -- Target environment name or id, eg, 'lovely-wombats-build-nimbly'.
  • NAME -- Name of the secret, e.g., 'user-some-secret'.

Related commands:

  • 'metaplay secrets create ENVIRONMENT NAME ...' to create a new user secret.
  • 'metaplay secrets delete ENVIRONMENT NAME ...' to delete a user secret.
  • 'metaplay secrets list ENVIRONMENT ...' to list all user secrets.
  • 'metaplay secrets show ENVIRONMENT NAME ...' to show the contents of a user secret.

Examples ​

sh
# Update an existing entry's value
metaplay secrets update nimbly user-mysecret --from-literal=password=newsecret
# Add a new entry to an existing secret
metaplay secrets update nimbly user-mysecret --from-literal=apikey=abc123
# Add entry from file
metaplay secrets update nimbly user-mysecret --from-file=certificate=./cert.pem
# Remove an entry
metaplay secrets update nimbly user-mysecret --remove=oldkey
# Combine: update one entry and remove another
metaplay secrets update nimbly user-mysecret --from-literal=password=new --remove=deprecated-key

Flags ​

  • --from-file <stringArray>: Add or update an entry with the value read from a file (e.g., key=filepath) (default: [])
  • --from-literal <stringArray>: Add or update an entry using a literal value (e.g., key=value) (default: [])
  • --remove <stringArray>: Remove an entry by key (default: [])

Inherited Flags ​

  • --color <string>: Should the output be colored (yes/no/auto)? [env: METAPLAYCLI_COLOR] (default: auto)
  • --project <string>: Path to the to project directory (where metaplay-project.yaml is located)
  • --skip-version-check: Skip the check for a new CLI version being available
  • --verbose: Enable verbose logging, useful for troubleshooting [env: METAPLAYCLI_VERBOSE]